Class: ColumnList

Source Location: /easy/element/ColumnList.php

Class ColumnList

Class Overview

ColumnList class is element that show description from "Selection.xml" on column/table view

Located in /easy/element/ColumnList.php [line 27]

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

Author(s):

Agus Suhartono, Rocky Swen (original ListBox and ColumnText author)

API Tags:

Access:

public

Information Tags:

Copyright:

Properties

Methods

[ Top ]

Inherited Properties, Constants, and Methods

Inherited Properties

Inherited Methods

Inherited Constants

Inherited From OptionElement

OptionElement::$m_SelectFrom

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 OptionElement

OptionElement::GetFromList()

OptionElement::GetSelectFrom()

Get select from

OptionElement::ReadMetaData()

Read metadata info from metadata array and store to class variable

OptionElement::Render()

Render, draw the control according to the mode

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_ColumnStyle
mixed	$m_Sortable

[ Top ]

Method Summary

string	getLink()	Get link that evaluated by Expression::EvaluateExpression
void	readMetaData()	Read metadata info from metadata array and store to class variable
string	render()	Draw/Render the element to show description
string	renderLabel()	When render table, it return the table header; when render array, it return the display name
void	setSortFlag()	set the sort flag of the element

[ Top ]

Properties

mixed $m_ColumnStyle [line 30]

API Tags:

Access:

public

[ Top ]

mixed $m_Sortable [line 29]

API Tags:

Access:

public

[ Top ]

Methods

getLink [line 61]

string getLink(
)

Get link that evaluated by Expression::EvaluateExpression

API Tags:

Return:	link
Access:	protected

[ Top ]

readMetaData [line 38]

void readMetaData(
array
&$xmlArr 
)

Read metadata info from metadata array and store to class variable

Parameters:

array

$xmlArr:

metadata array

API Tags:

Access:

protected

[ Top ]

render [line 100]

string render(
)

Draw/Render the element to show description

API Tags:

Return:	HTML text
Access:	public

[ Top ]

renderLabel [line 75]

string renderLabel(
)

When render table, it return the table header; when render array, it return the display name

API Tags:

Return:	HTML text
Access:	public

[ Top ]

setSortFlag [line 51]

void setSortFlag(
[integer
$flag = null] 
)

set the sort flag of the element

Parameters:

integer

$flag:

1 or 0

API Tags:

Access:

public

[ Top ]

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

	openbiz.bin.easy.element

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