Packageindex Classtrees Modulegroups Elementlist Report XML Files
 
File: c:/www/apache/doc2//form/form_element_selectobject.inc
PHPLib Form Rewrite 2001/03/01 - Form

form_element_selectobject

form_commonobject
   |
  +-- form_element
     |
    +-- form_element_selectobject

Superclass of select and combo.

 

private abstract class form_element_selectobject extends form_element

Superclass of select and combo.

AuthorsUlf Wendel <uw@netuse.de>
Version$Id: form_element_selectobject.inc,v 1.5 2000/12/12 01:37:40 uw Exp $
 
Direct known subclasses: form_element_combo, form_element_select

Methods inherited from form_element
form_element, setup, checkconfiguration, getvalue, gettype, isbutton, getvalidator, setvalidator, freeze, unfreeze, thawout, get, show, validate, validatelength, validateregex, dovalidation, react, getjsonactivation, getcommonhtmlattributes, getfrozenhiddenelement, getfrozentable, getjs, getjsvalue, getextrajs, getname, ishidden

Methods inherited from form_commonobject
introspection

Private Method Summary
boolean

setOptions(array $options)

Sets the option list of the select or combo box.
string

isSelected(string $value)

FIXME
boolean

setValue(mixed $value)

Sets the current value.Warning: documentation is missing.
string

validateIntro()

Checks whether an intro option was selected.
string

getIntroOptionTags()

Returns a HTML string with all intro option tags.
string

getOptionTags()

Returns a HTML string with of all option tags.
void

getfrozen([ string $value ])

Returns thr HTML code of the frozen element.Warning: documentation is missing.

Fields inherited from form_element
$flag_config_ok, $elname, $name, $value, $additional_html, $frozen, $class, $id, $style, $shared_required_fields, $shared_optional_fields, $optional_fields, $method, $val_events, $js_mode, $form_name, $validator, $js_validator

Fields inherited from form_commonobject
$cr_html, $exceptions

Private Field Summary
string

$size

HTML size attribute.
string

$intro

First option in a select or combo box with some advice to select another option.
string

$intro_e

Error message used when an intro field gets selected.
array

$seperators

Undocumented and unimplemented. FIXME
string

$seperators_e

Error message used when a selector gets selected
array

$options

Array of options.
string

$accesskey

HTML accesskey attribute.
integer

$tabindex

HTML tabindex attribute.
array

$required_fields

List of required fields provided by a derived class.

Private Method Details

setOptions

private boolean setOptions( array $options )
  Sets the option list of the select or combo box.

Parameter
array $options
Returns boolean

Throws form_error
See Also $options

isSelected

private string isSelected( string $value )
  FIXME

Parameter
string $value
Returns string $selected

Returns " selected" if the given value is selected

setValue

private boolean setValue( mixed $value )
  Sets the current value.

Warning: documentation is missing.

Parameter
mixed $value
$value must be skalar if it's not a select multiple and
can be an array if it's select multiple is set.
Returns boolean $ok
Throws form_error

validateIntro

private string validateIntro( )
  Checks whether an intro option was selected.

Returns string $message

If not empty, an introption was selected.

getIntroOptionTags

private string getIntroOptionTags( )
  Returns a HTML string with all intro option tags.

Returns string

HTML

See Also getOptionTags()

getOptionTags

private string getOptionTags( )
  Returns a HTML string with of all option tags.

Returns string $html
See Also getIntroOptionTags()

getfrozen

private void getfrozen( [ string $value ] )
  Returns thr HTML code of the frozen element.

Warning: documentation is missing.

Parameter
string $value = >>""<<
The value is only used with radio buttons.
If the given value is equal to the value of the
element when it was defined, the radio gets selected.
Returns void

See Also get(), show()

Private Field Details

$size

private string $size

>>""<<

HTML size attribute.

$intro

private string $intro

>>""<<

First option in a select or combo box with some advice to select another option.
You probably know these select boxes where the first option is "Please choose...".That's what's intro for. The intro message is not a valid choise. If selected it'salwayscausing an error message (but only when intro_e is specified).

See Also $intro_e

$intro_e

private string $intro_e

>>""<<

Error message used when an intro field gets selected.

See Also $intro

$seperators

private array $seperators

>>array()<<

Undocumented and unimplemented. FIXME
Seperators in a list of option which can't be selected.

See Also $seperators_e

$seperators_e

private string $seperators_e

>>""<<

Error message used when a selector gets selected

See Also $seperators

$options

private array $options

>>array()<<

Array of options.

See Also $intro, $intro_e, $seperators, $seperators_e

$accesskey

private string $accesskey

>>""<<

HTML accesskey attribute.

$tabindex

private integer $tabindex

>>-1<<

HTML tabindex attribute.

$required_fields

private array $required_fields

>>array ( "options" => "array" )<<

List of required fields provided by a derived class.

See Also $shared_required_fields, $optional_fields
Packageindex Classtrees Modulegroups Elementlist Report XML Files
PHPDoc 1.0beta