Main Page | Packages | Class Tree | Index | Help
Previous | NextFrames | No Frames
Summary: Field | Property | Contructor | MethodDetail: Field | Property | Contructor | Method
xp.controls

class Label

MovieClip
  |
  +--xp.system.UIControl
        |
        +--xp.controls.TextBase
              |
              +--xp.controls.Label

All Known Subclasses: Button, CheckBox, ColumnHeader, ComboBox, DateField, Hyperlink, RadioButton, Separator, TitleBar
class Label
extends TextBase

A non-editable, single or multi line text field.


Author:
ProWin Computers Ltd. - Rob Edgar

Version:
3.0.0.000

See also:
support@epresenterplus.com

Field Summary

public static
classInfo: Object
A static class information object

public
styleClass: String
The name of the style class this instance will use.

Fields inherited from class xp.controls.TextBase

leading, leftMargin, rightMargin, textIndent

Fields inherited from class xp.system.UIControl

__layout, allowDrop, autoLayout, bindingDefaultValue, bindingFormatter, bindingPath, bindingSource, bindingType, bindingValidator, border, causesValidation, classInfo, clickOnENTER, clickOnSPACE, container, context, data, disableAcceptButton, disableCancelButton, enableBGMouseEvents, enableDblClickEvent, enableKeyDownEvents, enableKeyEvents, enableKeyUpEvents, enableMouseWheelEvents, formatterOptions, horizontalAlignment, index, isBinding, itemId, logEnabled, parent, parentContainer, parentForm, percentageHeight, percentageWidth, styleClass, tabIndex, tabStop, tooltip, tree, verticalAlignment

Property Summary

public
autoEllipsis: Boolean (read, write)
Gets or sets a value indicating whether the ellipsis character (...) appears at the right edge of the Label, denoting that the Label text extends beyond the specified length of the Label.

public
hAnchorPoint: String (read, write)
Controls the vertical anchor or registration point of a Label.

public
html: Boolean (read, write)
A Boolean value that indicates whether a label can be formatted with HTML (true) or not (false).

public
icon (read, write)
The library symbol of the icon set to load

public
iconIndex: String (read, write)
This selects a particular icon from the set of icons loaded

public
styleSheet: TextField.StyleSheet (read, write)
Sets the stylesheet to be used by this object.

public
vAnchorPoint: String (read, write)
Controls the vertical anchor or registration point of a Label.

Properties inherited from class xp.controls.TextBase

font, fontBold, fontColor, fontEmbed, fontFamily, fontItalic, fontName, fontSize, fontStyle, fontUnderline, fontWeight, text, textAlign, textDecoration, textWrap

Properties inherited from class xp.system.UIControl

alpha, autosize, background, backgroundVisible, bindings, borderBrush, borderRadius, borderShadow, borderStyle, borderThickness, bottom, dataSource, enableMouseEvents, focusManager, height, id, isEnabled, isFocused, isMouseOver, isPressed, isSelected, isValid, layout, left, margin, maxHeight, maxWidth, measuredHeight, measuredMinHeight, measuredMinWidth, measuredWidth, minHeight, minWidth, padding, readOnly, resources, right, styleName, top, triggers, visible, width, x, y

Constructor

public
Label ( )
Constructor - This should not be called directly.


Method Summary

public
drawComponent ( ): Void
layout the control

public
getClass ( ): Function
Returns a reference to the components static class

public static
newInstance ( owner, instanceId, depth, initObj )
Creates a new Instance of this class

Methods inherited from class xp.controls.TextBase

getTextEllipsis, getTextExtent

Methods inherited from class xp.system.UIControl

addBinding, addBindings, addEventListener, addPropertyTrigger, applyStyle, beginDeferUpdate, canUpdate, centerContent, checkState, containsFocus, destroy, destroyObject, drawFocus, endDeferUpdate, findFocusFromObject, findFocusInChildren, getBinding, getBounds, getCenter, getClass, getFocus, getFocusManager, getFocusRect, getLocation, getPropertyValue, getSize, getStateName, getTrigger, globalToLocalPoint, invalidate, invalidateLayout, invalidateSize, invalidateSizeAndLayout, invalidChild, isChild, isMouseDirectlyOver, isParent, localToGlobalPoint, localToLocalPoint, measure, mouseWheel, move, onChildFocus, onKillFocus, onSetFocus, processEnterKey, processEscapeKey, processTabKey, redraw, refresh, removeEventListener, routeEvent, setBounds, setFocus, setLocation, setPropertyValue, setSize, setValueChanged, update, validate


Field Documentation

classInfo

public static var classInfo: Object
A static class information object

Every class has an associated classInfo object that holds the version and other static information. The classInfo can be accessed either directly by referencing the static class or by calling getClass() on any class instance.

styleClass

public var styleClass: String
The name of the style class this instance will use.

Property Documentation

autoEllipsis

public autoEllipsis: Boolean (read, write)
Gets or sets a value indicating whether the ellipsis character (...) appears at the right edge of the Label, denoting that the Label text extends beyond the specified length of the Label.

true if the additional label text is to be indicated by an ellipsis; otherwise, false. The default is false.

hAnchorPoint

public hAnchorPoint: String (read, write)
Controls the vertical anchor or registration point of a Label.

By default it is top.

html

public html: Boolean (read, write)
A Boolean value that indicates whether a label can be formatted with HTML (true) or not (false).

icon

public icon (read, write)
The library symbol of the icon set to load

The icon property is the symbol of library clip. Setting this property causes the item to be loaded.

iconIndex

public iconIndex: String (read, write)
This selects a particular icon from the set of icons loaded

The iconIndex is the frame name or frame number the currently loaded icon should go to. Setting the index to "none" causes the icon to be hidden.

styleSheet

public styleSheet: TextField.StyleSheet (read, write)
Sets the stylesheet to be used by this object.

Setting this property automatically sets textWrap to true and html enables the Label.

vAnchorPoint

public vAnchorPoint: String (read, write)
Controls the vertical anchor or registration point of a Label.

By default it is top.

Constructor Documentation

Label

public function Label()
Constructor - This should not be called directly.

If you want to dynamically create a new instance of a control use its static newInstance method

Method Documentation

drawComponent

public function drawComponent(): Void
layout the control

Overrides:
xp.system.UIControl.drawComponent in class xp.system.UIControl

getClass

public function getClass(): Function
Returns a reference to the components static class

Overrides:
xp.system.UIControl.getClass in class xp.system.UIControl

newInstance

public static function newInstance(owner,
 instanceId,
 depth,
 initObj)
Creates a new Instance of this class

Creates an instance of a component at runtime. You need to use the import statement and specify the class package name before calling this method. In addition, the component must be in the FLA file’s library.

Parameters:
owner
A reference to the movie clip or object that will contains the new Instance.
instanceId
A string indicating the instance name of the new instance.(optional)
depth
A number indicating the depth of the new instance.(optional)
initObj
An object containing initialization properties for the new instance.(optional)
Returns:
A object that is an instance of the specified class.

The documentation was generated from the following file:

Generated on 10/30/2005 9:34:02 PM by AS2Doc