Class \Prado\Web\UI\WebControls\TWebControl

TWebControl class

TWebControl is the base class for controls that share a common set of UI-related properties and methods. TWebControl-derived controls are usually associated with HTML tags. They thus have tag name, attributes and body contents. You can override getTagName to specify the tag name, addAttributesToRender to specify the attributes to be rendered, and renderContents to customize the body content rendering. TWebControl encapsulates a set of properties related with CSS style fields, such as \Prado\Web\UI\WebControls\getBackColor, \Prado\Web\UI\WebControls\getBorderWidth, etc.

Subclasses of TWebControl typically needs to override addAttributesToRender and renderContents. The former is used to render the attributes of the HTML tag associated with the control, while the latter is to render the body contents enclosed within the HTML tag.

Class hierarchy

\Prado\Web\UI\WebControls\TWebControl implements IStyleable

\Prado\Web\UI\TControl implements IRenderable, IBindable

\Prado\TApplicationComponent

\Prado\TComponent

Author: Qiang Xue <qiang.xue@gmail.com>
Since: 3.0

Methods summary
`public`	`clearStyle() : mixed` Removes all style data.
`public`	`copyBaseAttributes(TWebControl $control) : mixed` Copies basic control attributes from another control. Properties including AccessKey, ToolTip, TabIndex, Enabled and Attributes are copied.
`public`	`getAccessKey() : string`
`public`	`getBackColor() : string`
`public`	`getBorderColor() : string`
`public`	`getBorderStyle() : string`
`public`	`getBorderWidth() : string`
`public`	`getCssClass() : string`
`public`	`getDecorator([bool $create = true ]) : TWebControlDecorator`
`public`	`getDisplay() : TDisplayStyle`
`public`	`getEnsureId() : bool`
`public`	`getFont() : TFont`
`public`	`getForeColor() : string`
`public`	`getHasStyle() : bool`
`public`	`getHeight() : string`
`public`	`getStyle() : TStyle`
`public`	`getTabIndex() : int`
`public`	`getToolTip() : string`
`public`	`getWidth() : string`
`public`	`onPreRender(TEventParameter $param) : mixed` If your subclass overrides the onPreRender method be sure to call this method through parent::onPreRender($param); so your sub-class can be decorated, among other things.
`public`	`render(THtmlWriter $writer) : mixed` Renders the control. This method overrides the parent implementation by replacing it with the following sequence: renderBeginTag renderContents renderEndTag
`public`	`renderBeginTag(THtmlWriter $writer) : mixed` Renders the openning tag for the control (including attributes)
`public`	`renderContents(THtmlWriter $writer) : mixed` Renders the body content enclosed between the control tag. By default, child controls and text strings will be rendered. You can override this method to provide customized content rendering.
`public`	`renderEndTag(THtmlWriter $writer) : mixed` Renders the closing tag for the control
`public`	`setAccessKey(string $value) : mixed` Sets the access key of the control. Only one-character string can be set, or an exception will be raised. Pass in an empty string if you want to disable access key.
`public`	`setBackColor(string $value) : mixed`
`public`	`setBorderColor(string $value) : mixed`
`public`	`setBorderStyle(string $value) : mixed`
`public`	`setBorderWidth(string $value) : mixed`
`public`	`setCssClass(string $value) : mixed`
`public`	`setDisplay(TDisplayStyle $value) : mixed`
`public`	`setEnsureId(bool $value) : mixed` Subclasses can override getEnsureId or just set this property. eg. If your subclass control does work with javascript and your class wants to flag that it requires an id to operate properly. Once set to true, it stays that way.
`public`	`setForeColor(string $value) : mixed`
`public`	`setHeight(string $value) : mixed`
`public`	`setStyle(string $value) : mixed` Sets the css style string of the control. The style string will be prefixed to the styles set via other control properties (e.g. Height, Width).
`public`	`setTabIndex(int $value) : mixed` Sets the tab index of the control. Pass 0 if you want to disable tab index.
`public`	`setToolTip(string $value) : mixed` Sets the tooltip of the control. Pass an empty string if you want to disable tooltip.
`public`	`setWidth(string $value) : mixed`
`protected`	`addAttributesToRender(THtmlWriter $writer) : mixed` Adds attribute name-value pairs to renderer. By default, the method will render 'id', 'accesskey', 'disabled', 'tabindex', 'title' and all custom attributes. The method can be overriden to provide customized attribute rendering.
`protected`	`createStyle() : TStyle` Creates a style object to be used by the control. This method may be overriden by controls to provide customized style.
`protected`	`getTagName() : string` Returns the tag name used for this control. By default, the tag name is 'span'. You can override this method to provide customized tag names.

Inherited methods
__call, __callStatic, __clone, __construct, __destruct, __get, __isset, __set, __sleep, __unset, __wakeup, addedControl, addParsedObject, applyStyleSheetSkin, asa, attachBehavior, attachBehaviors, attachClassBehavior, attachEventHandler, autoBindProperty, bindProperty, broadcastEvent, bubbleEvent, callBehaviorsMethod, canGetProperty, canSetProperty, clearBehaviors, clearNamingContainer, clearViewState, convertUniqueIdToClientId, createChildControls, createdOnTemplate, dataBind, detachBehavior, detachBehaviors, detachClassBehavior, detachEventHandler, disableBehavior, disableBehaviors, enableBehavior, enableBehaviors, ensureChildControls, evaluateExpression, evaluateStatements, findControl, findControlsByID, findControlsByType, focus, fxAttachClassBehavior, fxDetachClassBehavior, getAdapter, getAllowChildControls, getApplication, getAttribute, getAttributes, getAutoGlobalListen, getBehaviors, getBehaviorsEnabled, getClassHierarchy, getClientID, getControls, getCustomData, getEnabled, getEnableTheming, getEnableViewState, getEventHandlers, getHasAdapter, getHasAttributes, getHasChildInitialized, getHasControls, getHasInitialized, getHasLoaded, getHasLoadedPostData, getHasPreRendered, getID, getIsSkinApplied, getListeningToGlobalEvents, getNamingContainer, getPage, getParent, getPluginModule, getRegisteredObject, getRequest, getResponse, getService, getSession, getSkinID, getSourceTemplateControl, getSubProperty, getTemplateControl, getUniqueID, getUser, getViewState, getVisible, hasAttribute, hasEvent, hasEventHandler, hasMethod, hasProperty, isa, isObjectRegistered, listen, loadState, onDataBinding, onInit, onLoad, onPreRender, onUnload, publishAsset, publishFilePath, raiseEvent, registerObject, removeAttribute, removedControl, render, renderChildren, renderControl, saveState, setAdapter, setAttribute, setCustomData, setEnabled, setEnableTheming, setEnableViewState, setID, setPage, setSkinID, setSubProperty, setTemplateControl, setViewState, setVisible, trackViewState, unbindProperty, unlisten, unregisterObject, _getZappableSleepProps, autoDataBindProperties, clearChildState, clearControlState, createControlCollection, dataBindChildren, dataBindProperties, getCallChain, getChildControlsCreated, getClassFxEvents, getControlStage, getControlState, initRecursive, instanceBehavior, isDescendentOf, loadRecursive, loadStateRecursive, preRenderRecursive, raiseBubbleEvent, saveStateRecursive, setChildControlsCreated, setControlStage, setControlState, traverseChildControls, unloadRecursive, broadcastEventInternal, clearCachedUniqueID, clearNameTable, fillNameTable, filter_prado_fx, generateAutomaticID

Inherited constants
\Prado\Web\UI\TControl::AUTOMATIC_ID_PREFIX, \Prado\Web\UI\TControl::CLIENT_ID_SEPARATOR, \Prado\Web\UI\TControl::CS_CHILD_INITIALIZED, \Prado\Web\UI\TControl::CS_CONSTRUCTED, \Prado\Web\UI\TControl::CS_INITIALIZED, \Prado\Web\UI\TControl::CS_LOADED, \Prado\Web\UI\TControl::CS_PRERENDERED, \Prado\Web\UI\TControl::CS_STATE_LOADED, \Prado\TApplicationComponent::FX_CACHE_FILE, \Prado\TComponent::GLOBAL_RAISE_EVENT_LISTENER, \Prado\Web\UI\TControl::ID_FORMAT, \Prado\Web\UI\TControl::ID_SEPARATOR, \Prado\Web\UI\TControl::IS_CHILD_CREATED, \Prado\Web\UI\TControl::IS_CREATING_CHILD, \Prado\Web\UI\TControl::IS_DISABLE_THEMING, \Prado\Web\UI\TControl::IS_DISABLE_VIEWSTATE, \Prado\Web\UI\TControl::IS_ID_SET, \Prado\Web\UI\TControl::IS_SKIN_APPLIED, \Prado\Web\UI\TControl::IS_STYLESHEET_APPLIED, \Prado\Web\UI\TControl::RF_ADAPTER, \Prado\Web\UI\TControl::RF_AUTO_BINDINGS, \Prado\Web\UI\TControl::RF_CHILD_STATE, \Prado\Web\UI\TControl::RF_CONTROLS, \Prado\Web\UI\TControl::RF_CONTROLSTATE, \Prado\Web\UI\TControl::RF_DATA_BINDINGS, \Prado\Web\UI\TControl::RF_EVENTS, \Prado\Web\UI\TControl::RF_NAMED_CONTROLS, \Prado\Web\UI\TControl::RF_NAMED_CONTROLS_ID, \Prado\Web\UI\TControl::RF_NAMED_OBJECTS, \Prado\Web\UI\TControl::RF_SKIN_ID

Classes

Interfaces

Traits

Search results

Class \Prado\Web\UI\WebControls\TWebControl

Class hierarchy