Docs For Class Component

Component __construct(
mixed
$oParentPage, [mixed
$oComponentNode = NULL])

Construct a new component

Tags:

access:

public

Overridden in child classes as:

ComponentDataTable::__construct(): Creates a dataTable component.

ComponentDynamicOutput::__construct(): Creates a dynamicOutput component.

Overrides XmlObject::__construct() (parent method not documented)

[ Top ]

void createNewDatabaseFieldIfRequested(
)

Tags:

access:

public

[ Top ]

void doActionToUrlRedirections(
mixed
$sAction)

Tags:

access:

public

Overridden in child classes as:

ComponentButton::doActionToUrlRedirections()

ComponentDataTable::doActionToUrlRedirections()

ComponentRadiobuttonGroup::doActionToUrlRedirections()

[ Top ]

string getComponentCode(
)

Returns PHP code generated by the component which implements the component's functionality.

This function may be overwritten by a component.

Tags:

return:	PHP code
access:	public

Overridden in child classes as:

ComponentButton::getComponentCode(): Returns the code that is required to render the component on the screen. If the application is in the edit mode then it puts a little move icon along with the component to allow it to be moved.

ComponentCheckbox::getComponentCode(): Returns the code that is required to render the checkbox on the screen.

ComponentDataTable::getComponentCode(): Returns the code to render a data table.

ComponentDynamicOutput::getComponentCode(): Returns the html text

ComponentHtmlText::getComponentCode(): Returns the html text as it is. This text can be put in the final code as it is since the actual code is generated by the FCKEditor

ComponentImage::getComponentCode(): Returns the code that is required to render the image on the screen.

ComponentInputText::getComponentCode(): Returns the code that is required to render the component on the screen. If the application is in the edit mode then it puts a little move icon along with the component to allow it to be moved.

ComponentRadiobuttonGroup::getComponentCode(): Returns the code that is required to render the component on the screen. If the application is in the edit mode then it puts a little move icon along with the component to allow it to be moved.

[ Top ]

string getComponentCodeBeforeHtmlTag(
)

Returns PHP code generated by the component which implements the component's functionality.

Code returned by this function is included before the starting <html> tag of the page and is therefore suitable to deal with input processing, page forwarding etc.

This function may be overwritten by a component.

Tags:

return:	PHP code
access:	public

Overridden in child classes as:

ComponentButton::getComponentCodeBeforeHtmlTag(): Returns code required to perform the actions to be performed on the button click as specified by the designer.

ComponentInputText::getComponentCodeBeforeHtmlTag(): Returns the code that goes before the HTML tag, this is essentially input text validation.

ComponentRadiobuttonGroup::getComponentCodeBeforeHtmlTag(): Returns PHP code that should be inserted before the HTML tag in the generated PHP file

[ Top ]

boolean getComponentIdExpandedDefault(
)

Returns whether or not the input field for the component Id should be shown expanded by default or not (ie. collapsed). This function may be overwritten by individual components

Tags:

return:	TRUE if component ID input field should be shown as expanded
access:	public

Overridden in child classes as:

ComponentButton::getComponentIdExpandedDefault(): Returns whether or not the input field for the component Id should be shown expanded by default or not (ie. collapsed).

ComponentCheckbox::getComponentIdExpandedDefault(): Returns whether or not the input field for the component Id should be shown expanded by default or not (ie. collapsed).

ComponentInputText::getComponentIdExpandedDefault(): Returns whether or not the input field for the component Id should be shown expanded by default or not (ie. collapsed).

ComponentRadiobuttonGroup::getComponentIdExpandedDefault(): Returns whether or not the input field for the component Id should be shown expanded by default or not (ie. collapsed).

[ Top ]

string getHtmlEditorCustomization(
)

Returns javascript code to put a drop down in the HTML Editor tool bar for adding input fields and database field directly into the HTML text without typing it in. This function can be overridden if special buttons or dropdowns need to be added to the HTML Editor toolbar.

Tags:

return:	javascript code
access:	public

Overridden in child classes as:

ComponentDynamicOutput::getHtmlEditorCustomization(): Returns javascript code to put a drop down in the HTML Editor tool bar for adding input fields and database field directly into the HTML text without typing it in.

[ Top ]

string getId(
)

Returns the component's Id from the XML

Tags:

return:	The Id
access:	public

[ Top ]

Application getParentApp(
)

Returns the parent Application of this component

Tags:

return:	A reference to the parent application containing this component
access:	public

[ Top ]

Page getParentPage(
)

Returns the parent Page of this object

Tags:

return:	A reference to the parent page containing this object
access:	public

[ Top ]

string getType(
)

Returns the type of the component as text.

This function is overwritten by each component. It must be implemented.

Tags:

return:	Type of the component, e.g. "inputText", "htmlText" etc.
access:	public

Overridden in child classes as:

ComponentButton::getType(): Returns the type of the component i.e. button

ComponentCheckbox::getType(): Returns the type of the component i.e. checkbox

ComponentDataTable::getType(): Returns the type of the component i.e. dataTable

ComponentDynamicOutput::getType(): Returns the type of the component i.e. dynamicOutput

ComponentHtmlText::getType(): Returns the type of the component i.e. htmlText

ComponentImage::getType(): Returns the type of the component i.e. image

ComponentInputText::getType(): Returns the type of the component i.e. inputText

ComponentRadiobuttonGroup::getType(): Returns the type of the component i.e. radiobuttonGroup

[ Top ]

int getX(
)

Returns the component's X-screen coordinate from the XML

Tags:

return:	The X coordinate
access:	public

[ Top ]

int getY(
)

Returns the component's Y-screen coordinate from the XML

Tags:

return:	The Y coordinate
access:	public

[ Top ]

int getZ(
)

Returns the component's Z-screen coordinate (the depth) from the XML

Tags:

return:	The Z coordinate
access:	public

[ Top ]

boolean handlePropertiesUi(
boolean
$bSuccessSoFar)

Responds to user input from the edit component screen, performs input validation and stores input values until they are saved or discarded.

This function is overwritten by each component. It must be implemented.

Tags:

return:	TRUE if no user input error occurred, FALSE otherwise
access:	public

Overridden in child classes as:

ComponentButton::handlePropertiesUi(): Responds to user input from the edit component screen, performs input validation and stores input values until they are saved or discarded

ComponentCheckbox::handlePropertiesUi(): Responds to user input from the edit component screen, this validates the input and simply stores the values entered by the user to the XML file.

ComponentDataTable::handlePropertiesUi(): Responds to user input from the edit component screen, performs input validation and stores input values until they are saved or discarded

ComponentDynamicOutput::handlePropertiesUi(): Responds to user input from the edit component screen, performs input validation and stores input values until they are saved or discarded

ComponentHtmlText::handlePropertiesUi(): Responds to user input from the edit component screen, performs input validation and stores input values until they are saved or discarded

ComponentImage::handlePropertiesUi(): Responds to user input from the edit component screen, performs input validation and stores input values until they are saved or discarded

ComponentInputText::handlePropertiesUi(): Responds to user input from the edit component screen, performs input validation and stores input values until they are saved or discarded

ComponentRadiobuttonGroup::handlePropertiesUi(): Responds to user input from the edit component screen, performs input validation and stores input values until they are saved or discarded

Parameters:

boolean

$bSuccessSoFar

whether all the properties input have been successful, this is required to let the handlePropertiesUi know that editComponent has already found a problem with the entered id so it should not create a database element corresponding to it.

[ Top ]

void isActive(
)

Returns TRUE if this component is currently marked active

Tags:

access:

public

[ Top ]

boolean isComplete(
)

Returns true if complete functionality of the component has been defined, otherwise false

Tags:

return:	TRUE, if behavior completely defined else false
access:	public

Overridden in child classes as:

ComponentButton::isComplete(): Returns true if at least one action rule is defined for the button

ComponentCheckbox::isComplete(): Returns true if the input text has been associated with a database field or not. This is done by simply checking the database fieldname in the XML file.

ComponentInputText::isComplete(): Returns true if the input text field has been associated with a database field or not. This is done by simply checking the database fieldname in the XML file.

ComponentRadiobuttonGroup::isComplete(): Returns TRUE if the component is fully specified

[ Top ]

void printComponentHelp(
string
$sIndex)

This function is a wrapper which calls the global printHelp from common.inc.php

Tags:

access:

protected

Parameters:

string

$sIndex

help id specific to this component

[ Top ]

void printHtmlEditorUi(
mixed
$sHtml)

Prints the UI for an HTML editor

This is only relevant for some components

Tags:

static:
access:	public

[ Top ]

void printJavaScriptOnChangeFunction(
)

This function puts a javscript function in the edit component dialog box that handles the component id change. whenever the component id changes we add this new id into the list of options for the field it is associated to in a database.

Tags:

access:

public

[ Top ]

void printLinkToDatabaseFieldUi(
)

Prints the UI for linking a component to a database field

This is only relevant for some of the input components

Tags:

access:

protected

[ Top ]

void printPropertiesUi(
)

Outputs the User Interface for editing the components properties.

This function is overwritten by each component. It must be implemented.

Tags:

access:

public

Overridden in child classes as:

ComponentButton::printPropertiesUi(): This is the main function that creates the button component creation dialog box

ComponentCheckbox::printPropertiesUi(): Dispays properties UI

ComponentDataTable::printPropertiesUi(): This function invokes a dialog box which allows creation of SQL query for the data table and the styles used to display the information for the datatable.

ComponentDynamicOutput::printPropertiesUi(): This function invokes a dialog box which contains an instantiated object of the FCKEditor It allows to create custom HTML providing all the relevant functionality provided by the FCKEditor.

ComponentHtmlText::printPropertiesUi(): This function invokes a dialog box which contains an instantiated object of the FCKEditor It allows to create custom HTML providing all the relevant functionality provided by the FCKEditor.

ComponentImage::printPropertiesUi(): This is the main function that creates the image component creation dialog box

ComponentInputText::printPropertiesUi(): This is the main function that creates the inputText component creation dialog box

ComponentRadiobuttonGroup::printPropertiesUi(): Display the properties of the radiobutton group

[ Top ]

void printSubmitFormFunction(
)

Tags:

access:

public

[ Top ]

string rewriteLinksForEditMode(
string
$sCode)

This function rewrites all HTML links '<a href="something">' to '<a href="something?editMode=1">'

Tags:

return:	The HTML code with links rewritten
access:	public

Parameters:

string

$sCode

The HTML code to be rewritten

[ Top ]

void setActive(
)

Makes this component active

Tags:

access:

public

[ Top ]

void setId(
string
$sId)

Sets the component's Id in the XML

Tags:

access:

public

Parameters:

string

$sId

The new component Id

[ Top ]

void setX(
int
$iX)

Sets the component's X-screen coordinate in the XML

Tags:

access:

public

Parameters:

int

$iX

The new X coordinate

[ Top ]

void setY(
int
$iY)

Sets the component's Y-screen coordinate in the XML

Tags:

access:

public

Parameters:

int

$iY

The new Y coordinate

[ Top ]

void setZ(
int
$iZ)

Sets the component's Z-screen coordinate in the XML

Tags:

access:

public

Parameters:

int

$iZ

The new Z coordinate

[ Top ]

void unsetActive(
)

Makes this component inactive

Tags:

static:
access:	public

[ Top ]

Class: Component

Class Overview

Methods

Child classes:

Inherited Methods

Class: XmlObject

Class Details

Class Methods

constructor __construct [line 12]

Tags:

method createNewDatabaseFieldIfRequested [line 256]

Tags:

method doActionToUrlRedirections [line 149]

Tags:

method getComponentCode [line 173]

Tags:

method getComponentCodeBeforeHtmlTag [line 186]

Tags:

method getComponentIdExpandedDefault [line 216]

Tags:

method getHtmlEditorCustomization [line 197]

Tags:

method getId [line 23]

Tags:

method getParentApp [line 130]

Tags:

method getParentPage [line 121]

Tags:

method getType [line 141]

Tags:

method getX [line 41]

Tags:

method getY [line 59]

Tags:

method getZ [line 77]

Tags:

method handlePropertiesUi [line 162]

Tags:

Parameters:

method isActive [line 107]

Tags:

method isComplete [line 206]

Tags:

method printComponentHelp [line 376]

Tags:

Parameters:

method printHtmlEditorUi [line 353]

Tags:

method printJavaScriptOnChangeFunction [line 225]

Tags:

method printLinkToDatabaseFieldUi [line 297]

Tags:

method printPropertiesUi [line 148]

Tags:

method printSubmitFormFunction [line 275]

Tags:

method rewriteLinksForEditMode [line 387]

Tags:

Parameters:

method setActive [line 93]

Tags:

method setId [line 32]

Tags:

Parameters:

method setX [line 50]

Tags:

Parameters:

method setY [line 68]

Tags:

Parameters:

method setZ [line 86]

Tags:

Parameters:

method unsetActive [line 100]

Tags: