|
Class TDropDownList
TDropDownList class
TDropDownList displays a dropdown list on a Web page. It inherits all
properties and events from TListControl .
Since v3.0.3, TDropDownList starts to support optgroup. To specify an option
group for a list item, set a Group attribute with it,
$listitem->Attributes->Group="Group Name";
Since v3.1.1, TDropDownList starts to support prompt text. That is, a prompt
item can be displayed as the first list item by specifying either setPromptText PromptText or setPromptValue PromptValue, or both.
Choosing the prompt item will unselect the TDropDownList.
When a prompt item is set, its index in the list is set to -1. So, the getSelectedIndex SelectedIndex property is not affected by a prompt item: the
items list will still be zero-based.
The clearSelection clearSelection method will select the prompt item
if existing, otherway the first available item in the dropdown list will be
selected.
-
TComponent
-
TApplicationComponent
-
TControl
implements
IRenderable,
IBindable
-
TWebControl
implements
IStyleable
-
TDataBoundControl
-
TListControl
implements
IDataRenderer
-
TDropDownList
implements
IPostBackDataHandler,
IValidatable
Methods summary
protected
|
#
addAttributesToRender( THtmlWriter $writer )
Adds attributes to renderer.
Adds attributes to renderer.
Parameters
Overrides
|
protected
string
|
#
getClientClassName( )
Gets the name of the javascript class responsible for performing postback for
this control. This method overrides the parent implementation.
Gets the name of the javascript class responsible for performing postback for
this control. This method overrides the parent implementation.
Returns
string the javascript class name
Overrides
|
public
boolean
|
#
loadPostData( string $key, array $values )
Loads user input data. This method is primarly used by framework
developers.
Loads user input data. This method is primarly used by framework
developers.
Parameters
- $key
string the key that can be used to retrieve data from the input data collection
- $values
array the input data collection
Returns
boolean whether the data of the component has been changed
Implementation of
|
public
|
#
raisePostDataChangedEvent( )
Raises postdata changed event. This method is required by IPostBackDataHandler interface. It is invoked by the framework when getSelectedIndex SelectedIndex property is changed on postback. This method is
primarly used by framework developers.
Raises postdata changed event. This method is required by IPostBackDataHandler interface. It is invoked by the framework when getSelectedIndex SelectedIndex property is changed on postback. This method is
primarly used by framework developers.
Implementation of
|
public
boolean
|
#
getDataChanged( )
Returns a value indicating whether postback has caused the control data
change. This method is required by the IPostBackDataHandler interface.
Returns a value indicating whether postback has caused the control data
change. This method is required by the IPostBackDataHandler interface.
Returns
boolean whether postback has caused the control data change. False if the page is not in
postback mode.
Implementation of
|
public
|
#
setSelectedIndices( array $indices )
Parameters
- $indices
array list of index of items to be selected
Throws
Overrides
|
public
mixed
|
#
getValidationPropertyValue( )
Returns the value to be validated. This methid is required by IValidatable
interface.
Returns the value to be validated. This methid is required by IValidatable
interface.
Returns
mixed the value of the property to be validated.
Implementation of
|
public
boolean
|
#
getIsValid( )
Returns true if this control validated successfully. Defaults to true.
Returns true if this control validated successfully. Defaults to true.
Returns
boolean wether this control validated successfully.
Implementation of
|
public
boolean
|
#
setIsValid( boolean $value )
Parameters
- $value
boolean wether this control is valid.
Returns
boolean wether this control's validators validated successfully
Implementation of
|
Methods inherited from TListControl
addParsedObject(),
clearSelection(),
createListItemCollection(),
formatDataValue(),
getAppendDataBoundItems(),
getAutoPostBack(),
getCausesValidation(),
getData(),
getDataGroupField(),
getDataTextField(),
getDataTextFormatString(),
getDataValueField(),
getEnableClientScript(),
getHasItems(),
getIsMultiSelect(),
getItemCount(),
getItems(),
getPostBackOptions(),
getPromptText(),
getPromptValue(),
getSelectedIndex(),
getSelectedIndices(),
getSelectedItem(),
getSelectedValue(),
getSelectedValues(),
getTagName(),
getText(),
getValidationGroup(),
loadState(),
onSelectedIndexChanged(),
onTextChanged(),
performDataBinding(),
renderClientControlScript(),
renderContents(),
renderPrompt(),
saveState(),
setAppendDataBoundItems(),
setAutoPostBack(),
setCausesValidation(),
setData(),
setDataGroupField(),
setDataTextField(),
setDataTextFormatString(),
setDataValueField(),
setEnableClientScript(),
setPromptText(),
setPromptValue(),
setSelectedIndex(),
setSelectedValue(),
setSelectedValues(),
setText(),
setValidationGroup()
|
Methods inherited from TDataBoundControl
createPagedDataSource(),
dataBind(),
dataSourceViewChanged(),
determineDataSource(),
ensureDataBound(),
getAllowCustomPaging(),
getAllowPaging(),
getCurrentPageIndex(),
getDataMember(),
getDataSource(),
getDataSourceID(),
getDataSourceView(),
getInitialized(),
getIsDataBound(),
getPageCount(),
getPageSize(),
getRequiresDataBinding(),
getSelectParameters(),
getUsingDataSourceID(),
getVirtualItemCount(),
onDataBound(),
onDataSourceChanged(),
onInit(),
onPreRender(),
pagePreLoad(),
setAllowCustomPaging(),
setAllowPaging(),
setCurrentPageIndex(),
setDataMember(),
setDataSource(),
setDataSourceID(),
setInitialized(),
setIsDataBound(),
setPageSize(),
setRequiresDataBinding(),
setVirtualItemCount(),
validateDataSource()
|
Methods inherited from TWebControl
clearStyle(),
copyBaseAttributes(),
createStyle(),
getAccessKey(),
getBackColor(),
getBorderColor(),
getBorderStyle(),
getBorderWidth(),
getCssClass(),
getDecorator(),
getDisplay(),
getEnsureId(),
getFont(),
getForeColor(),
getHasStyle(),
getHeight(),
getStyle(),
getTabIndex(),
getToolTip(),
getWidth(),
render(),
renderBeginTag(),
renderEndTag(),
setAccessKey(),
setBackColor(),
setBorderColor(),
setBorderStyle(),
setBorderWidth(),
setCssClass(),
setDisplay(),
setEnsureId(),
setForeColor(),
setHeight(),
setStyle(),
setTabIndex(),
setToolTip(),
setWidth()
|
Methods inherited from TControl
__construct(),
__get(),
addToPostDataLoader(),
addedControl(),
applyStyleSheetSkin(),
autoBindProperty(),
autoDataBindProperties(),
bindProperty(),
broadcastEvent(),
bubbleEvent(),
clearChildState(),
clearControlState(),
clearNamingContainer(),
clearViewState(),
convertUniqueIdToClientId(),
createChildControls(),
createControlCollection(),
dataBindChildren(),
dataBindProperties(),
ensureChildControls(),
findControl(),
findControlsByID(),
findControlsByType(),
focus(),
getAdapter(),
getAllowChildControls(),
getAttribute(),
getAttributes(),
getChildControlsCreated(),
getClientID(),
getControlStage(),
getControlState(),
getControls(),
getCustomData(),
getEnableTheming(),
getEnableViewState(),
getEnabled(),
getHasAdapter(),
getHasAttributes(),
getHasChildInitialized(),
getHasControls(),
getHasInitialized(),
getHasLoaded(),
getHasLoadedPostData(),
getHasPreRendered(),
getID(),
getIsSkinApplied(),
getNamingContainer(),
getPage(),
getParent(),
getRegisteredObject(),
getSkinID(),
getSourceTemplateControl(),
getTemplateControl(),
getUniqueID(),
getViewState(),
getVisible(),
hasAttribute(),
initRecursive(),
isDescendentOf(),
isObjectRegistered(),
loadRecursive(),
loadStateRecursive(),
onDataBinding(),
onLoad(),
onUnload(),
preRenderRecursive(),
raiseBubbleEvent(),
registerObject(),
removeAttribute(),
removedControl(),
renderChildren(),
renderControl(),
saveStateRecursive(),
setAdapter(),
setAttribute(),
setChildControlsCreated(),
setControlStage(),
setControlState(),
setCustomData(),
setEnableTheming(),
setEnableViewState(),
setEnabled(),
setID(),
setPage(),
setSkinID(),
setTemplateControl(),
setViewState(),
setVisible(),
trackViewState(),
traverseChildControls(),
unbindProperty(),
unloadRecursive(),
unregisterObject()
|
Methods inherited from TComponent
__call(),
__destruct(),
__isset(),
__set(),
__sleep(),
__unset(),
__wakeup(),
asa(),
attachBehavior(),
attachBehaviors(),
attachClassBehavior(),
attachEventHandler(),
canGetProperty(),
canSetProperty(),
clearBehaviors(),
createdOnTemplate(),
detachBehavior(),
detachBehaviors(),
detachClassBehavior(),
detachEventHandler(),
disableBehavior(),
disableBehaviors(),
enableBehavior(),
enableBehaviors(),
evaluateExpression(),
evaluateStatements(),
fxAttachClassBehavior(),
fxDetachClassBehavior(),
getAutoGlobalListen(),
getBehaviorsEnabled(),
getClassHierarchy(),
getEventHandlers(),
getListeningToGlobalEvents(),
getSubProperty(),
hasEvent(),
hasEventHandler(),
hasProperty(),
isa(),
listen(),
raiseEvent(),
setSubProperty(),
unlisten()
|
Constants inherited from TControl
AUTOMATIC_ID_PREFIX,
CLIENT_ID_SEPARATOR,
CS_CHILD_INITIALIZED,
CS_CONSTRUCTED,
CS_INITIALIZED,
CS_LOADED,
CS_PRERENDERED,
CS_STATE_LOADED,
ID_FORMAT,
ID_SEPARATOR,
IS_CHILD_CREATED,
IS_CREATING_CHILD,
IS_DISABLE_THEMING,
IS_DISABLE_VIEWSTATE,
IS_ID_SET,
IS_SKIN_APPLIED,
IS_STYLESHEET_APPLIED,
RF_ADAPTER,
RF_AUTO_BINDINGS,
RF_CHILD_STATE,
RF_CONTROLS,
RF_CONTROLSTATE,
RF_DATA_BINDINGS,
RF_EVENTS,
RF_NAMED_CONTROLS,
RF_NAMED_CONTROLS_ID,
RF_NAMED_OBJECTS,
RF_SKIN_ID
|
|