pnForm
[ class tree: pnForm ] [ index: pnForm ] [ all elements ]

Class: pnFormPostBackFunction

Source Location: /system/pnForm/plugins/function.pnformpostbackfunction.php

Class Overview

pnFormPlugin
   |
   --pnFormPostBackFunction

PostBack JavaScript function plugin


Variables

Methods


Inherited Variables

Inherited Methods

Class: pnFormPlugin

pnFormPlugin::pnFormPlugin()
Constructor
pnFormPlugin::create()
Create event handler
pnFormPlugin::dataBound()
DataBound event handler
pnFormPlugin::decode()
Decode event handler
pnFormPlugin::decodePostBackEvent()
Decode event handler for actions that generate a postback event
pnFormPlugin::getIdHtml()
Utility function to generate HTML for ID attribute
pnFormPlugin::initialize()
Initialize event handler
pnFormPlugin::load()
Load event handler
pnFormPlugin::postRender()
PostRender event handler
pnFormPlugin::readParameters()
Read Smarty plugin parameters
pnFormPlugin::registerPlugin()
pnFormPlugin::render()
Render event handler
pnFormPlugin::renderAttributes()
pnFormPlugin::renderBegin()
RenderBegin event handler
pnFormPlugin::renderContent()
RenderContent event handler
pnFormPlugin::renderEnd()
RenderEnd event handler

Class Details

[line 31]
PostBack JavaScript function plugin

Use this plugin to create a postback generating JavaScript function to be called from your JavaScript code.

Example:

  1.  <!--[pnformpostbackfunction function=startMyPostBack commandName=abc]-->
This generates a JavaScript function named startMyPostBack() that you can call from your own JavaScript. When called it will generate a postback and fire an event to be handled by the $onCommand method in the form event handler.




[ Top ]


Class Variables

$commandName =

[line 39]

Command name

This is the "commandName" parameter to pass in the event args of the command handler.



Type:   string


[ Top ]

$function =

[line 49]

JavaScript function name to generate

This is the name of a JavaScript function you want to be created on the page. By calling this function in your own JavaScript code you can initiate a postback that will call the pnFormPostBackFunction::$onCommand event handler and pass pnFormPostBackFunction::$commandName to it.



Type:   mixed


[ Top ]

$onCommand =  'handleCommand'

[line 55]

Name of command event handler method



Tags:

var:  Default is "handleCommand"

Type:   string


[ Top ]



Class Methods


method getFilename [line 65]

string getFilename( )

Get filename for this plugin

A requirement from the framework - must be implemented like this. Used to restore plugins on postback.




[ Top ]

method raisePostBackEvent [line 83]

void raisePostBackEvent( &$render, $eventArgument)



Parameters:

   &$render  
   $eventArgument  

[ Top ]

method render [line 71]

void render( &$render)



Overrides pnFormPlugin::render() (Render event handler)

Parameters:

   &$render  

[ Top ]


Documentation generated on Fri, 18 Jul 2008 21:45:56 +0200 by phpDocumentor 1.4.1