phpDocumentor SForm
Elements
[ class tree: SForm ] [ index: SForm ] [ all elements ]

Class: SForm_Elm_Button

Source Location: /SForm.php

Class SForm_Elm_Button

Direct descendents
Child Class Description
SForm_Elm_Reset A reset element
SForm_Elm_Submit A submit element

[ Top ]
Inherited Properties, Constants, and Methods
Inherited Properties Inherited Methods Inherited Constants

Inherited From SForm_Element

SForm_Element::$addName
SForm_Element::$attributes
SForm_Element::$defId
SForm_Element::$emptyTag
SForm_Element::$errors
SForm_Element::$filters
SForm_Element::$locked
SForm_Element::$parent
SForm_Element::$required
SForm_Element::$rules
SForm_Element::$tag
SForm_Element::$validated
SForm_Element::$valueSet

Inherited From SForm_Element

SForm_Element::__construct()
Construct with an identity. Optionally add a label and more attributes.
SForm_Element::addRule()
Add a rule to this element
SForm_Element::assignParent()
Assign this element's parent
SForm_Element::autoAK()
Generates an access key and updated label
SForm_Element::createRule()
Creates & returns a rule
SForm_Element::escHtml()
Escape HTML in a consistant manner
SForm_Element::filter()
Apply a filter to the value
SForm_Element::filterValue()
Filters the value
SForm_Element::freeze()
Set if this element is frozen
SForm_Element::getAttribute()
Get an attribute in $this
SForm_Element::getAttributesString()
Creates an HTML attribute string from an array
SForm_Element::getErrorHtml()
Do we have any errors?
SForm_Element::getGlobalId()
This is the page-wide unique ID
SForm_Element::getLabel()
Return the label string (no markup)
SForm_Element::getLabelHtml()
Return the label with markup added
SForm_Element::getLocalId()
A Locally usable ID
SForm_Element::getOption()
Get a global option
SForm_Element::getRequest()
Returns a value from the request
SForm_Element::getValue()
The value of this element
SForm_Element::isFrozen()
Is this element marked as frozen?
SForm_Element::isRequired()
Is this element required?
SForm_Element::lock()
Locks & adds any last minute stuff
SForm_Element::render()
Append this leaf element to the render queue
SForm_Element::setAttribute()
Set an attribute in $this
SForm_Element::setDefault()
Set the default value of this element
SForm_Element::setOption()
Set a global option
SForm_Element::setValue()
Set the value of this element
SForm_Element::toHidden()
Do we have any hidden tags to append?
SForm_Element::toHtml()
Create a HTML representation of this element
SForm_Element::toHtmlFin()
Close an open HTML tags
SForm_Element::toJavaScript()
Retrieve any JavaScript that should be run onsubmit
SForm_Element::toString()
How does this value look as a HTML string?
SForm_Element::unsetAttribute()
Unset an attribute
SForm_Element::validate()
Is this a valid element?
SForm_Element::wasSubmitted()
Was this form submitted?

[ Top ]
Property Summary
string   $type   Type of button

[ Top ]
Method Summary
SForm_Elm_Button   __construct()   Add button type info
string   toHtml()   Frozen returns no button

[ Top ]
Properties
string   $type = 'button' [line 3733]

Type of button

API Tags:
Access:  protected


Redefined in descendants as:

[ Top ]
Methods
Constructor __construct  [line 3742]

  SForm_Elm_Button __construct( [string $id = null], [string $label = null], [array $attributes = null]  )

Add button type info

Parameters:
string   $id:  Local ID of this element
string   $label:  The button text
array   $attributes:  Any extra attributes

API Tags:
Access:  public


Redefinition of:
SForm_Element::__construct()
Construct with an identity. Optionally add a label and more attributes.

[ Top ]
toHtml  [line 3760]

  string toHtml( )

Frozen returns no button

Being frozen disables all buttons, because without being clickable they are useless.


API Tags:
Return:  HTML as appropriate
Access:  public


Redefinition of:
SForm_Element::toHtml()
Create a HTML representation of this element

[ Top ]

Documentation generated on Mon, 09 Apr 2007 19:08:33 -0500 by phpDocumentor 1.3.0