Class: Element

Source Location: /easy/element/Element.php

Class Element

Class Overview

Element class is the base class of all HTML Element

Located in /easy/element/Element.php [line 25]

MetaObject
   |
   --Element

Author(s):

Rocky Swen

API Tags:

Access:

public

Information Tags:

Copyright:

Properties

Methods

[ Top ]

Direct descendents

Child Class	Description
Hidden	Button class is hidden element
HTMLBlock	HTMLBlock class is element that write HTML block borderd by <div> tag
InputElement	InputElement class is based element for all input element
LabelText	LebelText - class LabelText is element that view value who binds with a BizField
RawData	RawData class is element for render raw data

[ Top ]

Inherited Properties, Constants, and Methods

Inherited Properties

Inherited Methods

Inherited Constants

Inherited From MetaObject

MetaObject::$m_Access

MetaObject::$m_Class

MetaObject::$m_Description

MetaObject::$m_Name

MetaObject::$m_Package

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_AllowURLParam
mixed	$m_ClientValidator
mixed	$m_cssClass
mixed	$m_cssErrorClass
mixed	$m_EventHandlers
mixed	$m_FormName
mixed	$m_FuzzySearch
mixed	$m_Height
mixed	$m_Hidden
mixed	$m_HTMLAttr
mixed	$m_OnEventLog
mixed	$m_Required
mixed	$m_SortFlag
mixed	$m_Style
mixed	$m_Translatable
mixed	$m_Validator
mixed	$m_Value
mixed	$m_Width

[ Top ]

Method Summary

void	__construct()	Initialize Element with xml array
	AdjustFormName()	Adjust form name change the FormName after inherit from parent form
boolean	CanDisplayed()	Check if the element can be displayed
boolean	CheckRequired()	Check if element must required (must have value)
	GetClientValidator()	Get client validator
array	GetContextMenu()	Get context menu
	GetDefaultValue()	Get default value
EasyForm	GetFormObj()	Get form object
string	GetFunction()	Get function of element in JavaScript format
	GetFunctionType()	Get function type
	GetHidden()	Get hidden status
	GetProperty()	Get property of element
string	GetRedirectPage()	Get redirect page
array	GetSCKeyFuncMap()	Get shortcut key function map
string	GetStyle()	Get style of element
string	GetText()	Get text of element
	GetValue()	Get value of element
void	ReadMetaData()	Read array meta data, and store to meta object
string	Render()	Render the element by html
void	SetValue()	Set value of element
	Validate()	Validate element

[ Top ]

Properties

mixed $m_AllowURLParam = 'N' [line 38]

API Tags:

Access:

public

[ Top ]

mixed $m_ClientValidator = null [line 45]

API Tags:

Access:

public

[ Top ]

mixed $m_cssClass [line 28]

API Tags:

Access:

public

[ Top ]

mixed $m_cssErrorClass [line 29]

API Tags:

Access:

public

[ Top ]

mixed $m_EventHandlers [line 34]

API Tags:

Access:

public

[ Top ]

mixed $m_FormName [line 42]

API Tags:

Access:

public

[ Top ]

mixed $m_FuzzySearch [line 36]

API Tags:

Access:

public

[ Top ]

mixed $m_Height [line 31]

API Tags:

Access:

public

[ Top ]

mixed $m_Hidden = "N" [line 32]

API Tags:

Access:

public

[ Top ]

mixed $m_HTMLAttr [line 33]

API Tags:

Access:

public

[ Top ]

mixed $m_OnEventLog [line 37]

API Tags:

Access:

public

[ Top ]

mixed $m_Required = null [line 43]

API Tags:

Access:

public

Redefined in descendants as:

InputElement::$m_Required

[ Top ]

mixed $m_SortFlag [line 40]

API Tags:

Access:

public

[ Top ]

mixed $m_Style [line 27]

API Tags:

Access:

public

[ Top ]

mixed $m_Translatable [line 35]

API Tags:

Access:

public

[ Top ]

mixed $m_Validator = null [line 44]

API Tags:

Access:

public

[ Top ]

mixed $m_Value = "" [line 41]

API Tags:

Access:

public

[ Top ]

mixed $m_Width [line 30]

API Tags:

Access:

public

[ Top ]

Methods

Constructor __construct [line 53]

void __construct(
array
&$xmlArr, mixed
$formObj 
)

Initialize Element with xml array

Parameters:

array

$xmlArr:

Redefinition of:

MetaObject::__construct()

Redefined in descendants as:

FileUploader::__construct() : Initialize Element with xml array
ImageUploader::__construct() : Initialize Element with xml array

[ Top ]

AdjustFormName [line 122]

 AdjustFormName(
string
$formName 
)

Adjust form name change the FormName after inherit from parent form

Parameters:

string

$formName:

API Tags:

Access:

public

[ Top ]

CanDisplayed [line 173]

boolean CanDisplayed(
)

Check if the element can be displayed

API Tags:

Access:

public

[ Top ]

CheckRequired [line 369]

boolean CheckRequired(
)

Check if element must required (must have value)

API Tags:

Access:

public

[ Top ]

GetClientValidator [line 401]

 GetClientValidator(
)

Get client validator

API Tags:

Access:

public

[ Top ]

GetContextMenu [line 290]

array GetContextMenu(
)

Get context menu

API Tags:

Access:

public

[ Top ]

GetDefaultValue [line 187]

 GetDefaultValue(
)

Get default value

API Tags:

Access:

public

Redefined in descendants as:

InputElement::GetDefaultValue() : Get default value of element

[ Top ]

GetFormObj [line 109]

EasyForm GetFormObj(
)

Get form object

API Tags:

Access:

protected

[ Top ]

GetFunction [line 316]

string GetFunction(
)

Get function of element in JavaScript format

API Tags:

Access:

protected

Redefined in descendants as:

EditCombobox::GetFunction() : Get function of element in JavaScript format

[ Top ]

GetFunctionType [line 357]

 GetFunctionType(
string
$ehName 
)

Get function type

Parameters:

string

$ehName:

event handler name

API Tags:

Access:

public

[ Top ]

GetHidden [line 211]

 GetHidden(
)

Get hidden status

API Tags:

Access:

protected

[ Top ]

GetProperty [line 160]

 GetProperty(

$propertyName 
)

Get property of element

Parameters:

$propertyName:

API Tags:

Access:

public

Redefinition of:

MetaObject::GetProperty(): Get property

[ Top ]

GetRedirectPage [line 342]

string GetRedirectPage(
string
$ehName 
)

Get redirect page

Parameters:

string

$ehName:

event handler name

API Tags:

Access:

public

[ Top ]

GetSCKeyFuncMap [line 263]

array GetSCKeyFuncMap(
)

Get shortcut key function map

API Tags:

Access:

public

[ Top ]

GetStyle [line 222]

string GetStyle(
)

Get style of element

API Tags:

Access:

protected

Redefined in descendants as:

EditCombobox::GetStyle() : Get style of element

[ Top ]

GetText [line 250]

string GetText(
)

Get text of element

API Tags:

Access:

protected

Redefined in descendants as:

LabelText::GetText() : Get text of label
RawData::GetText() : Get text of element

[ Top ]

GetValue [line 149]

 GetValue(
)

Get value of element

API Tags:

Access:

public

Redefined in descendants as:

Checkbox::GetValue() : Get value of element
InputPassword::GetValue() : Get value of element

[ Top ]

ReadMetaData [line 67]

void ReadMetaData(
array
&$xmlArr 
)

Read array meta data, and store to meta object

Parameters:

array

$xmlArr:

API Tags:

Access:

protected

Redefinition of:

MetaObject::ReadMetaData(): Read meta data

Redefined in descendants as:

Hidden::ReadMetaData() : Read array meta data, and store to meta object
InputElement::ReadMetaData() : Read array meta data, and store to meta object
Button::ReadMetaData() : Read array meta data, and store to meta object
CKEditor::ReadMetaData() : Read array meta data, and store to meta object
FileUploader::ReadMetaData() : Read array meta data, and store to meta object
ImageUploader::ReadMetaData() : Read array meta data, and store to meta object
InputDate::ReadMetaData() : Read array meta data, and store to meta object
InputDatetime::ReadMetaData() : Read array meta data, and store to meta object
InputPicker::ReadMetaData() : Read array meta data, and store to meta object
OptionElement::ReadMetaData() : Read metadata info from metadata array and store to class variable
EditCombobox::ReadMetaData() : Read array meta data, and store to meta object
Listbox::ReadMetaData() : Read metadata info from metadata array and store to class variable
InputPassword::ReadMetaData() : Read array meta data, and store to meta object
LabelText::ReadMetaData() : Read array meta data, and store to meta object
ColumnText::ReadMetaData() : Read array meta data, and store to meta object
ColumnBool::ReadMetaData() : Read array meta data, and store to meta object
ColumnImage::ReadMetaData() : Read array meta data, and store to meta object
ColumnPassword::ReadMetaData() : Read array meta data, and store to meta object
LabelPassword::ReadMetaData() : Read array meta data, and store to meta object
RawData::ReadMetaData() : Read metadata info from metadata array and store to class variable

[ Top ]

Render [line 201]

string Render(
)

Render the element by html

API Tags:

Return:	HTML text
Access:	public

Redefined in descendants as:

Hidden::Render() : Draw the element according to the mode
HTMLBlock::Render() : Render/Draw the control according to the mode
InputElement::Render() : Render, draw the element according to the mode just return element value
Button::Render() : Render element, according to the mode
CKEditor::Render() : Render element, according to the mode
File::Render() : Render the element, according to the mode
HTMLButton::Render() : Render / draw the element according to the mode
InputText::Render() : Render, draw the control according to the mode
InputDate::Render() : Render / draw the element according to the mode
InputDatetime::Render() : Render / draw the element according to the mode
InputPicker::Render() : Render, draw the control according to the mode
LightColorPicker::Render() : Render, draw the control with a popup color picker
OptionElement::Render() : Render, draw the control according to the mode
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
Password::Render() : Render, draw the control according to the mode
InputPassword::Render()
ResetButton::Render() : Render, draw the element according to the mode
RichText::Render() : Render, draw the element according to the mode
RowCheckbox::Render() : Render, draw the element according to the mode
SubmitButton::Render() : Render, draw the element according to the mode
Textarea::Render() : Render, draw the element according to the mode
LabelText::Render() : Render, draw the element according to the mode
ColumnBool::Render() : Render element, according to the mode
ColumnImage::Render() : Render element, according to the mode
ColumnPassword::Render() : Render element, according to the mode
LabelPassword::Render() : Render, draw the control according to the mode
RawData::Render() : Render, draw the element according to the mode

[ Top ]

SetValue [line 139]

void SetValue(

$val 
)

Set value of element

Parameters:

$val:

API Tags:

Access:

public

Redefined in descendants as:

FileUploader::SetValue() : Set value of element
ImageUploader::SetValue() : Set value of element
InputPassword::SetValue() : Set value of element

[ Top ]

Validate [line 388]

 Validate(
)

Validate element

API Tags:

Access:

public

[ Top ]

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

	openbiz.bin.easy.element

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