Controls
FoundationLabelControl
A simple control representing a piece of text on the page.
- Object
- SitedObject
- Control
- LabelControl
Remarks
LabelControl inserts a piece of text into the HTML page.
LabelControl renders as a <span>. The value of the ID_text
property becomes the contents of the span.
By default, LabelControl does not process the text in any way, so if it contains HTML markup that markup will be shown on the page.
[Todo: add a property to disable this and escape the text.]
LabelControl is typically used together with databinding to insert dynamic text on the page.
Properties
| ID_animators (inherited from Control) | A SitedList of animators. |
| ID_controlId (inherited from Control) | The ID this control is known in the nearest binding container parent. |
| ID_escapeHtml | Whether to allow HTML elements within the text. |
| ID_eventMask (inherited from Control) | (Advanced) A comma-separated list of peer events this control should receive. |
| ID_isBindingContainer (inherited from Control) | (Advanced) Force this control to act as a binding container. |
| ID_isPeerless (inherited from Control) | (Advanced) Set this to true to prevent this control from generating a peer element in the rendered HTML. |
| ID_submitters (inherited from Control) | A SitedList of submitters. |
| ID_tagName (inherited from Control) | Overrides the default HTML tag name used for this control. |
| ID_text | The text to show in this label. |
| ID_visible (inherited from Control) | True if this control is visible, false if it is hidden. |
Events
| ID_mouseDown (inherited from Control) | Event handler called when a mouse button is pressed down. |
| ID_mouseMove (inherited from Control) | Event handler called when the mouse is moved. |
| ID_mouseOut (inherited from Control) | Event handler called when a leaves a control. |
| ID_mouseOver (inherited from Control) | Event handler called when a mouse moves over a control. |
| ID_mouseUp (inherited from Control) | Event handler called when a mouse button is released. |
Methods
| acceptsDrop (inherited from Control) | Called to determine if this control will accept a drop. |
| addBinding (inherited from Control) | Adds a databinding between a property on this object and a binding path. |
| addBindingEx (inherited from Control) | Extended entry point for adding a binding. |
| addCalculatedBinding (inherited from Control) | Adds a calculated binding for a property. |
| addClassName (inherited from Control) | Adds a CSS class to this controls "class" attribute |
| addEventHandler (inherited from SitedObject) | Adds a delegate to be called when the specified eventId occurs on this object. |
| animateEx (inherited from Control) | Animates a property to a value. |
| blur (inherited from Control) | Tells this control's peer to relinquish keyboard focus. |
| bubble (inherited from Control) | Bubbles a message up the control hierarchy - calls onBubbleEvent on this control and each of its parents. |
| captureMouse (inherited from Control) | Register a control to receive mouse move/up events |
| construct (inherited from Control) | Used to initialize a markup control. |
| equals (inherited from SitedObject) | Tests if two objects are equal. |
| fireEventHandler (inherited from SitedObject) | Invokes any user event handlers registered for a particular event using SitedObject.addEventHandler(). |
| focus (inherited from Control) | Tells this control's peer to request keyboard focus. |
| getBindingContainer (inherited from Control) | Gets this object's nearest enclosing binding container. |
| getBindingStatus (inherited from SitedObject) | Provides debugging information on bindings for this object. |
| getEventMask (inherited from Control) | Gets an object indicating which peer events this control is interested in. |
| getParent (inherited from Control) | Gets the parent Control of this control. |
| getPathValue (inherited from SitedObject) | Traverses a binding path and returns the value at the end of it. |
| getPeer (inherited from Control) | Gets the peer DOM element associated with this control. |
| getPeerForParent (inherited from Control) | Gets the peer element of this control that the parent control should use in DOM manipulations. |
| getPropertyInfo (inherited from SitedObject) | Gets information on a property. |
| getResource (inherited from Control) | Given the ID of a resource, returns the resource's value. |
| getSite (inherited from SitedObject) | Gets this object's site. |
| getTagName (inherited from Control) | Gets the HTML tag name this control will use for its peer element. |
| getText | Gets the text shown in the label. |
| getValue (inherited from Control) | Gets a property, style or attribute. |
| getViewState (inherited from Control) | Retrieve any viewstate that has been saved for this control in a previous session. |
| getViewStateId (inherited from Control) | Get a unique and consistent viewstateId for this control. |
| invalidateLayout (inherited from Control) | Tells the layout system to redo layout. |
| onBubbleEvent (inherited from Control) | Called to handle a bubbled event. |
| onDragEvent (inherited from Control) | Called to handle a drag drop event.. |
| onFirstRender (inherited from Control) | Called the first time a control is rendered. |
| onPeerCreated (inherited from Control) | Called when a peer is created. |
| onPeerEvent (inherited from Control) | Called to dispatch low level events that arise in the Dom. |
| onSetValue (inherited from SitedObject) | Called by SitedObject.setValue() when a property value is set on this object. |
| onSited (inherited from SitedObject) | Called when this object is sited. |
| onSitedRoot (inherited from Control) | Called when a control is added to the main control tree. |
| onUnsited (inherited from SitedObject) | Called when this object is about to lose its site. |
| onUnsitedRoot (inherited from Control) | Called when a control is removed from the main control tree. |
| onValueSited (inherited from SitedObject) | Called when an object is sited within this object. |
| onValueUnsited (inherited from SitedObject) | Called when an object is about to be unsited in this. |
| onViewStateChanged (inherited from Control) | Overridable. Controls implement this method to update their viewstate. |
| reflectOnBoundValue (inherited from Control) | Gets runtime reflection information on an underlying bound object. |
| removeClassName (inherited from Control) | Removes a CSS class from this controls "class" attribute |
| removeEventHandler (inherited from SitedObject) | Remove an existing delegate from the list of delegates for the specified event. |
| render (inherited from Control) | Places the Html representation of this control into the htmlBuilder. |
| renderAttributes (inherited from Control) | Called by Control.render() to render attributes for this control. |
| renderChildren (inherited from Control) | Places the Html markup for all the Control inside this control into the htmlBuilder. |
| setBounds (inherited from Control) | Convenience method to set the left/top/width/height of an element. |
| setInitialValues (inherited from SitedObject) | Sets multiple property values on an object (during initialization only) |
| setPathValue (inherited from SitedObject) | Traverses a binding path and sets the value at the end of it. |
| setText | Sets the text shown in the label. |
| setValue (inherited from Control) | Sets a property, style or attribute. |
| setViewState (inherited from Control) | Save viewstate that should persist across sessions. |
| startAnimator (inherited from Control) | Starts an animation. |
| startDragDrop (inherited from Control) | Start a drag drop operation. |
| stopAnimator (inherited from Control) | Stops an animation. |
| toString (inherited from SitedObject) | Returns a string representation of this object. |
LabelControl getText method
Gets the text shown in the label.
JavaScript
var strVal = labelControl.getText()
LabelControl ID_escapeHtml property
Whether to allow HTML elements within the text.
JavaScript
var boolVal = labelControl.getValue(ID_escapeHtml)
labelControl.setValue(ID_escapeHtml, boolVal)
Xml
<j:Label escapeHtml="true" ... >
or
<j:Label escapeHtml="false" ... >
Remarks
If this is true, then the special HTML characters <, >, and & within the ID_text are replaced by HTML entities.
If this is false, then any HTML markup within the ID_text string is rendered as-is in the browser - so the label can show rich text content.
Note that no well-formedness checks are performed by the Label control , so badly formed HTML within a label with escapeHtml="false" may break the page design.
LabelControl ID_text property
The text to show in this label.
JavaScript
var strVal = labelControl.getValue(ID_text)
labelControl.setValue(ID_text, strVal)
Xml
<j:Label text="string" ... >
Example
In Xml, you can specify the label using a databinding
<j:Label text="#bind(item.firstName)"/>
Alternatively, you can use straight text:
<j:Label text="Example"/>
In JavaScript, to set a label's text, use:
var label = new LabelControl(); label.setValue(ID_text, 'Here is the text');
LabelControl setText method
Sets the text shown in the label.
JavaScript
labelControl.setText(str)
Remarks
This is a convenience method for setting the
ID_text property of this control.