Class \Prado\Web\UI\WebControls\TWebControlDecorator

TWebControlDecorator class

A TWebControlDecorator can be applied to a TWebControl to customize its rendering. TWebControlDecorator can add custom html code before and after both the open and close tag of a TWebControl. The html code can be an user-defined text or an external template file that will be instantiated and rendered in place.

This is an easy way to have your look and feel depend upon the theme instead of writing specific html in your templates to achieve your website desires. Here is an example of how to code your theme skin:

<com:THeader3>
<prop:Decorator.PreTagText>
			<!-- Surround the control with a div and apply a css class to it -->
	<div class="imported-theme-h3-container">
</prop:Decorator.PreTagText>
<prop:Decorator.PostTagText>
			<!-- Properly close the tag -->
	</div>
</prop:Decorator.PostTagText>
</com:THeader3>

The order of the inclusion of the decoration into the page goes like this:

PreTagTemplate
PreTagText
TWebControl Open Tag Rendered
PreContentsText
PreContentsTemplate
TWebControl Children Rendered
PostContentsTemplate
PostContentsText
TWebControl CloseTag Rendered
PostTagText
PostTagTemplate

Class hierarchy

\Prado\Web\UI\WebControls\TWebControlDecorator

\Prado\TComponent

Author: Brad Anderson <javalizard@gmail.com>
Since: 3.2

Methods summary
`public`	`__construct(TWebControl $control[, bool $onlyinternal = false ]) : mixed` Constructor. Initializes the control .
`public`	`ensureTemplateDecoration([TComponent $sender = null ][, null\|mixed $param = null ]) : bool` This method places the templates around the open and close tag. This takes a parameter which is to specify the control to get the outer template decoration. If no outer control is specified
`public`	`getPostContentsTemplate() : null\|TTemplate`
`public`	`getPostContentsText() : string`
`public`	`getPostTagTemplate() : null\|TTemplate`
`public`	`getPostTagText() : string`
`public`	`getPreContentsTemplate() : null\|TTemplate`
`public`	`getPreContentsText() : string`
`public`	`getPreTagTemplate() : null\|TTemplate`
`public`	`getPreTagText() : string`
`public`	`getUseState() : bool`
`public`	`instantiate([null\|mixed $outercontrol = null ]) : mixed` This is a framework call. The Text decoration can't influence the object hierarchy because they are rendered into into the writer directly. This call attaches the ensureTemplateDecoration to the TPage onSaveStateComplete so these controls don't have page states. This is as close to not influencing the page as possible.
`public`	`renderPostContentsText(TTextWriter $writer) : mixed` This method places the post contents text into the {@see \Prado\IO\TTextWriter}
`public`	`renderPostTagText(TTextWriter $writer) : mixed` This method places the post tag text into the {@see \Prado\IO\TTextWriter}
`public`	`renderPreContentsText(TTextWriter $writer) : mixed` This method places the pre contents text into the {@see \Prado\IO\TTextWriter}
`public`	`renderPreTagText(TTextWriter $writer) : mixed` This method places the pre tag text into the {@see \Prado\IO\TTextWriter}
`public`	`setPostContentsTemplate(TTemplate $value) : mixed`
`public`	`setPostContentsText(string $value) : mixed`
`public`	`setPostTagTemplate(TTemplate $value) : mixed`
`public`	`setPostTagText(string $value) : mixed`
`public`	`setPreContentsTemplate(TTemplate $value) : mixed`
`public`	`setPreContentsText(string $value) : mixed`
`public`	`setPreTagTemplate(TTemplate $value) : mixed`
`public`	`setPreTagText(string $value) : mixed`
`public`	`setUseState(bool $value) : mixed`

Inherited methods
__call, __callStatic, __clone, __construct, __destruct, __get, __isset, __set, __sleep, __unset, __wakeup, addParsedObject, asa, attachBehavior, attachBehaviors, attachClassBehavior, attachEventHandler, callBehaviorsMethod, canGetProperty, canSetProperty, clearBehaviors, createdOnTemplate, detachBehavior, detachBehaviors, detachClassBehavior, detachEventHandler, disableBehavior, disableBehaviors, enableBehavior, enableBehaviors, evaluateExpression, evaluateStatements, fxAttachClassBehavior, fxDetachClassBehavior, getAutoGlobalListen, getBehaviors, getBehaviorsEnabled, getClassHierarchy, getEventHandlers, getListeningToGlobalEvents, getSubProperty, hasEvent, hasEventHandler, hasMethod, hasProperty, isa, listen, raiseEvent, setSubProperty, unlisten, _getZappableSleepProps, getCallChain, getClassFxEvents, instanceBehavior, filter_prado_fx

Inherited constants
`\Prado\TComponent::GLOBAL_RAISE_EVENT_LISTENER`

Classes

Interfaces

Traits

Search results

Class \Prado\Web\UI\WebControls\TWebControlDecorator

Class hierarchy