Class: OptionElement

Source Location: /easy/element/OptionElement.php

Class OptionElement

Class Overview

OptionElement is the base class of element that render list (from Selection.xml)

Used by :

AutoSuggest
Checkbox
ColumnList
EditCombobox
LabelList
Listbox

Located in /easy/element/OptionElement.php [line 34]

MetaObject
   |
   --Element
      |
      --InputElement
         |
         --OptionElement

Author(s):

Rocky Swen

API Tags:

Access:

public

Information Tags:

Copyright:

Properties

$m_SelectFrom

Methods

[ Top ]

Direct descendents

Child Class	Description
AutoSuggest	AutoSuggest class is element for AutoSuggest
Checkbox	Checkbox class is element for Checkbox
ColumnList	ColumnList class is element that show description from "Selection.xml" on column/table view
EditCombobox	EditCombobox class is element for EditCombobox
LabelList	LabelList class is element that show description (read only) from Selection.xml
Listbox	Listbox class is element that show ListBox with data from Selection.xml
Radio	Radio class is element that show RadioBox with data from Selection.xml

[ Top ]

Inherited Properties, Constants, and Methods

Inherited Properties

Inherited Methods

Inherited Constants

Inherited From InputElement

InputElement::$m_DefaultValue

InputElement::$m_Description

InputElement::$m_Enabled

InputElement::$m_FieldName

InputElement::$m_Label

InputElement::$m_Required

InputElement::$m_Text

Inherited From Element

Element::$m_AllowURLParam

Element::$m_ClientValidator

Element::$m_cssClass

Element::$m_cssErrorClass

Element::$m_EventHandlers

Element::$m_FormName

Element::$m_FuzzySearch

Element::$m_Height

Element::$m_Hidden

Element::$m_HTMLAttr

Element::$m_OnEventLog

Element::$m_SortFlag

Element::$m_Style

Element::$m_Translatable

Element::$m_Validator

Element::$m_Value

Element::$m_Width

Inherited From MetaObject

MetaObject::$m_Access

MetaObject::$m_Class

MetaObject::$m_Name

MetaObject::$m_Package

Inherited From InputElement

InputElement::AddSCKeyScript()

Add sort-cut key scripts

InputElement::GetDefaultValue()

Get default value of element

InputElement::GetEnabled()

Get enable status

InputElement::ReadMetaData()

Read array meta data, and store to meta object

InputElement::Render()

Render, draw the element according to the mode just return element value

InputElement::RenderLabel()

Render label, just return label value

Inherited From Element

Element::__construct()

Initialize Element with xml array

Element::AdjustFormName()

Adjust form name change the FormName after inherit from parent form

Element::CanDisplayed()

Check if the element can be displayed

Element::CheckRequired()

Check if element must required (must have value)

Element::GetClientValidator()

Get client validator

Element::GetContextMenu()

Get context menu

Element::GetDefaultValue()

Get default value

Element::GetFormObj()

Get form object

Element::GetFunction()

Get function of element in JavaScript format

Element::GetFunctionType()

Get function type

Element::GetHidden()

Get hidden status

Element::GetProperty()

Get property of element

Element::GetRedirectPage()

Get redirect page

Element::GetSCKeyFuncMap()

Get shortcut key function map

Element::GetStyle()

Get style of element

Element::GetText()

Get text of element

Element::GetValue()

Get value of element

Element::ReadMetaData()

Read array meta data, and store to meta object

Element::Render()

Render the element by html

Element::SetValue()

Set value of element

Element::Validate()

Validate element

Inherited From MetaObject

MetaObject::__construct()

MetaObject::AllowAccess()

MetaObject::GetProperty()

Get property

MetaObject::PrefixPackage()

Set Prefix Package

MetaObject::ReadMetaCollection()

Read metadata collection

MetaObject::ReadMetaData()

Read meta data

[ Top ]

Property Summary

mixed

$m_SelectFrom

[ Top ]

Method Summary

void	GetFromList()
string	GetSelectFrom()	Get select from
void	ReadMetaData()	Read metadata info from metadata array and store to class variable
string	Render()	Render, draw the control according to the mode

[ Top ]

Properties

mixed $m_SelectFrom [line 36]

API Tags:

Access:

public

[ Top ]

Methods

GetFromList [line 78]

void GetFromList(
mixed
&$list 
)

API Tags:

Access:

public

[ Top ]

GetSelectFrom [line 55]

string GetSelectFrom(
)

Get select from

API Tags:

Access:

protected

[ Top ]

ReadMetaData [line 44]

void ReadMetaData(
array
&$xmlArr 
)

Read metadata info from metadata array and store to class variable

Parameters:

array

$xmlArr:

metadata array

API Tags:

Access:

protected

Redefinition of:

InputElement::ReadMetaData(): Read array meta data, and store to meta object

Redefined in descendants as:

EditCombobox::ReadMetaData() : Read array meta data, and store to meta object
Listbox::ReadMetaData() : Read metadata info from metadata array and store to class variable

[ Top ]

Render [line 66]

string Render(
)

Render, draw the control according to the mode

API Tags:

Return:	HTML text
Access:	public

Redefinition of:

InputElement::Render(): Render, draw the element according to the mode just return element value

Redefined in descendants as:

AutoSuggest::Render() : Render element, according to the mode
Checkbox::Render() : Render element, according to the mode
EditCombobox::Render() : Render element, according to the mode
Listbox::Render() : Render, draw the control according to the mode
Radio::Render() : Render, draw the control according to the mode

[ Top ]

Documentation generated on Tue, 22 Dec 2009 03:03:11 -0800 by phpDocumentor 1.3.0RC3

	openbiz.bin.easy.element

[ class tree: openbiz.bin.easy.element ] [ index: openbiz.bin.easy.element ] [ all elements ]