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

Class: ComponentRadiobuttonGroup

Source Location: /components/radiobuttonGroup/ComponentRadiobuttonGroup.inc.php

Class Overview

XmlObject
   |
   --Component
      |
      --ComponentRadiobuttonGroup

Represents a group of radiobuttons


Methods


Inherited Methods

Class: Component

Component::__construct()
Construct a new component
Component::createNewDatabaseFieldIfRequested()
Component::doActionToUrlRedirections()
Component::getComponentCode()
Returns PHP code generated by the component which implements the component's functionality.
Component::getComponentCodeBeforeHtmlTag()
Returns PHP code generated by the component which implements the component's functionality.
Component::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
Component::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.
Component::getId()
Returns the component's Id from the XML
Component::getParentApp()
Returns the parent Application of this component
Component::getParentPage()
Returns the parent Page of this object
Component::getType()
Returns the type of the component as text.
Component::getX()
Returns the component's X-screen coordinate from the XML
Component::getY()
Returns the component's Y-screen coordinate from the XML
Component::getZ()
Returns the component's Z-screen coordinate (the depth) from the XML
Component::handlePropertiesUi()
Responds to user input from the edit component screen, performs input validation and stores input values until they are saved or discarded.
Component::isActive()
Returns TRUE if this component is currently marked active
Component::isComplete()
Returns true if complete functionality of the component has been defined, otherwise false
Component::printComponentHelp()
This function is a wrapper which calls the global printHelp from common.inc.php
Component::printHtmlEditorUi()
Prints the UI for an HTML editor
Component::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.
Component::printLinkToDatabaseFieldUi()
Prints the UI for linking a component to a database field
Component::printPropertiesUi()
Outputs the User Interface for editing the components properties.
Component::printSubmitFormFunction()
Component::rewriteLinksForEditMode()
This function rewrites all HTML links '<a href="something">' to '<a href="something?editMode=1">'
Component::setActive()
Makes this component active
Component::setId()
Sets the component's Id in the XML
Component::setX()
Sets the component's X-screen coordinate in the XML
Component::setY()
Sets the component's Y-screen coordinate in the XML
Component::setZ()
Sets the component's Z-screen coordinate in the XML
Component::unsetActive()
Makes this component inactive

Class: XmlObject

XmlObject::__construct()
XmlObject::getDom()
Returns a refernce to the DOMDocument that is at the root of this XML object
XmlObject::getFirstChildNodeByTagName()
Returns a reference to the first child XML node with a particular name
XmlObject::getOrCreateChildNodeByTagName()
Returns a reference to the first child XML node with a particular name.
XmlObject::getXmlNode()
Returns a reference to the DOMNode of this XML object
XmlObject::removeAllChildNodesByTagName()
Deletes all child nodes that have a particular name
XmlObject::setXmlNode()
Sets a refernce to the DOMNode.

Class Details

[line 7]
Represents a group of radiobuttons



[ Top ]


Class Methods


method createNewOption [line 376]

Option createNewOption( )

Creates a new option, i.e. '<option>'



Tags:

return:  Object that holds the option information
access:  public


[ Top ]

method deleteOptionByPosition [line 296]

void deleteOptionByPosition( int $iPosition)

Deletes an option from the XML



Tags:

access:  public


Parameters:

int   $iPosition   position of the option within the XML, starting with 0

[ Top ]

method doActionToUrlRedirections [line 130]

void doActionToUrlRedirections( mixed $sAction)



Tags:

access:  public


Overrides Component::doActionToUrlRedirections() (parent method not documented)

[ Top ]

method getComponentCode [line 210]

string 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.

around the screen




Tags:

return:  code to render the component in PHP. (will be changed later to output code in various other server-side languages.)
access:  public


Overrides Component::getComponentCode() (Returns PHP code generated by the component which implements the component's functionality.)

[ Top ]

method getComponentCodeBeforeHtmlTag [line 187]

string getComponentCodeBeforeHtmlTag( )

Returns PHP code that should be inserted before the HTML tag in the generated PHP file



Tags:

return:  HTML/PHP code
access:  public


Overrides Component::getComponentCodeBeforeHtmlTag() (Returns PHP code generated by the component which implements the component's functionality.)

[ Top ]

method getComponentIdExpandedDefault [line 463]

boolean getComponentIdExpandedDefault( )

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



Tags:

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


Overrides Component::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)

[ Top ]

method getDefaultOptionValue [line 336]

void getDefaultOptionValue( )

Returns the value of the default option or the empty string if no default option is chosen

$return string The value of the default option or the empty string ""




Tags:

access:  public


[ Top ]

method getLayout [line 404]

string getLayout( )

Returns the layout for this radiobutton group



Tags:

return:  Layout, either "horizontal" or "vertical"
access:  public


[ Top ]

method getOptionByPosition [line 354]

Option getOptionByPosition( int $iPosition)

Returns an option from the XML



Tags:

return:  object that contains the option indicated by the position or NULL
access:  public


Parameters:

int   $iPosition   position of the option within the XML, starting with 0

[ Top ]

method getOptions [line 387]

array getOptions( )

Returns an array of option objects



Tags:

return:  of objects of type Option
access:  public


[ Top ]

method getSaveValueDbFieldName [line 433]

string getSaveValueDbFieldName( )

Returns the name of the database field associated with this radiobutton group



Tags:

return:  Name of database field or empty as default
access:  public


[ Top ]

method getType [line 14]

string getType( )

Returns the type of the component i.e. radiobuttonGroup



Tags:

return:  radiobuttonGroup
access:  public


Overrides Component::getType() (Returns the type of the component as text.)

[ Top ]

method handlePropertiesUi [line 168]

boolean handlePropertiesUi( mixed $bInputErrorsSoFar)

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



Tags:

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


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

[ Top ]

method isComplete [line 197]

bool isComplete( )

Returns TRUE if the component is fully specified



Tags:

return:  TRUE if the component is fully specified
access:  public


Overrides Component::isComplete() (Returns true if complete functionality of the component has been defined, otherwise false)

[ Top ]

method makeDefaultOptionByPosition [line 316]

void makeDefaultOptionByPosition( int $iPosition)

Makes an option the default option (and unsets any previous default option)



Tags:

access:  public


Parameters:

int   $iPosition   position of the option within the XML, starting with 0

[ Top ]

method printBoxChooseLayout [line 31]

void printBoxChooseLayout( )

Prints on the dialog box screen for choosing the layout



Tags:

access:  public


[ Top ]

method printBoxDataConnection [line 22]

void printBoxDataConnection( )

Prints the data connection interface for the user to specify how to connect

the radio button group to a database




Tags:

access:  public


[ Top ]

method printBoxOptions [line 63]

void printBoxOptions( )

Prints the options along with buttons to edit/delete them



Tags:

access:  public


[ Top ]

method printPropertiesUi [line 154]

void printPropertiesUi( )

Display the properties of the radiobutton group



Tags:

access:  public


Overrides Component::printPropertiesUi() (Outputs the User Interface for editing the components properties.)

[ Top ]

method setLayout [line 418]

void setLayout( string $sType)

Sets the layout for this radiobutton group



Tags:

access:  public


Parameters:

string   $sType   Layout, either "horizontal" or "vertical"

[ Top ]

method setSaveValueDbFieldName [line 447]

void setSaveValueDbFieldName( string $sDbFieldName)

Sets the name of the database field associated with this radiobutton group



Tags:

access:  public


Parameters:

string   $sDbFieldName   Name of database field

[ Top ]


Documentation generated on Wed, 12 Jan 2005 17:51:09 -0500 by phpDocumentor 1.3.0RC3