Package | com.brightcove.api.components |
Class | public class Label |
Inheritance | Label ![]() ![]() ![]() |
Method | Defined By | ||
---|---|---|---|
Label(element:Object)
Constructor. | Label | ||
![]() | addEventListener(type:String, listener:Function, useCapture:Boolean = false, priority:int = 0, useWeakReference:Boolean = true):void [override]
Adds a listener for an event. | UIObject | |
![]() | getAlpha():Number
Returns the alpha value of the component. | Component | |
getAutoSize():Boolean
Returns whether the label resizes based on its text. | Label | ||
![]() | getBlendMode():String
Returns the blend mode of the component. | UIObject | |
getColor():int
Returns the font color used for the label. | Label | ||
![]() |
Returns the interface for the layout container of the element. | Component | |
![]() | getCSS():String
Returns the CSS used for this component instance. | UIObject | |
![]() | getDefinition():String
Returns the XML (BEML) definition of the component. | Component | |
![]() | getEnabled():Boolean
Returns whether component is enabled. | UIObject | |
getFont():String
Returns the name of the font used for the label. | Label | ||
getHAlign():String
Returns the horizontal alignment for the textfield in the label. | Label | ||
![]() | getHeight():Number
Returns the pixel height of the component. | Component | |
getHTMLEnabled():Boolean
Returns whether the label renders its text as HTML. | Label | ||
![]() | getID():String
Returns the ID of the component, as defined in the XML. | Component | |
![]() | getIncludeInLayout():Boolean
Returns whether the component is included in layout calculations and rendering in parent layout box. | Component | |
![]() | getIndex():int
Returns the index of this element in its parent's elements array. | Component | |
getIsTruncated():Boolean
Returns whether the label is currently truncated. | Label | ||
getMultiline():Boolean
Returns whether the label is set to be multiline. | Label | ||
![]() | getNextSibling():Object
Returns the interface for the layout element that is the next sibling to this element in the parent containers's element array. | Component | |
![]() | getNodeName():String
Returns the node name of the element. | Component | |
![]() | getPreviousSibling():Object
Returns the interface for the layout element that is the previous sibling to this element in the parent containers's element array. | Component | |
![]() | getRotation():Number
Returns the rotation of the component. | UIObject | |
getText():String
Returns the current text in the label. | Label | ||
getTextHeight():Number
Returns the current height of the textfield in the label. | Label | ||
getTextSize():Number
Returns the font point size used for the label. | Label | ||
getTextWidth():Number
Returns the current width of the textfield in the label. | Label | ||
getTruncate():Boolean
Returns whether the label is set to truncate its text if the textfield is larger than the label size. | Label | ||
getType():String
Returns the label's type, which determines its style format. | Label | ||
getUnderline():Boolean
Returns whether the label is set to underline the text. | Label | ||
getVAlign():String
Returns the vertical alignment for the textfield in the label. | Label | ||
![]() | getVisible():Boolean
Returns whether the component is visible. | Component | |
![]() | getWidth():Number
Returns the pixel width of the component. | Component | |
![]() | getX(global:Boolean = false):Number
Returns the position of the component on the x axis. | Component | |
![]() | getY(global:Boolean = false):Number
Returns the position of the component on the y axis. | Component | |
![]() | move(x:Number, y:Number, global:Boolean = false):void
Sets the x,y coordinates of the component. | Component | |
![]() | removeEventListener(type:String, listener:Function, useCapture:Boolean = false):void [override]
Removes a listener for an event. | UIObject | |
![]() | setAlpha(alpha:Number):void
Sets the alpha value of the component. | Component | |
setAutoSize(autoSize:Boolean):void
Sets whether the label should resize based on its text. | Label | ||
![]() | setBlendMode(mode:String):void
Sets the blend mode of the component. | UIObject | |
setColor(color:int):void
Sets a font color to be used instead of the style format's. | Label | ||
![]() | setEnabled(enable:Boolean):void
Enables/disables component for events. | UIObject | |
setFont(font:String):void
Sets a font to be used instead of the style format's. | Label | ||
setHAlign(align:String):void
Sets the horizontal alignment for the textfield in the label. | Label | ||
setHTMLEnabled(enabled:Boolean):void
Sets whether the label should render its text as HTML. | Label | ||
![]() | setIncludeInLayout(includeInLayout:Boolean):void
Sets whether the component is included in layout calculations and rendering in parent layout box. | Component | |
setMultiline(multiline:Boolean):void
Sets whether the label should display multiline. | Label | ||
![]() | setRotation(rotation:Number):void
Sets the rotation of the component. | UIObject | |
![]() | setSize(width:Number, height:Number):void
Sets the pixel dimensions for the wrapped component. | Component | |
![]() | setStyles(styles:String):void
Overrides specific styles for a component by accepting a semicolon-delimited list of style names and colors. | UIObject | |
setText(text:String):void
Sets the current text for the label. | Label | ||
setTextSize(size:Number):void
Sets a font size to be used instead of the style format's. | Label | ||
setTruncate(truncate:Boolean):void
Sets whether the label should truncate its text if the textfield is larger than the label size. | Label | ||
setType(type:String):void
Sets the label's type, which determines its style format. | Label | ||
setUnderline(underline:Boolean):void
Sets whether the label text should be underlined. | Label | ||
setVAlign(align:String):void
Sets the vertical alignment for the textfield in the label. | Label | ||
![]() | setVisible(visible:Boolean):void
Sets whether the component is visible. | Component |
Label | () | Constructor |
public function Label(element:Object)
Constructor.
Parameterselement:Object — layout element to wrap and delegate all calls to.
|
getAutoSize | () | method |
public function getAutoSize():Boolean
Returns whether the label resizes based on its text.
ReturnsBoolean — True if the label resizes based on its text.
|
getColor | () | method |
public function getColor():int
Returns the font color used for the label.
Returnsint — The value of the color.
|
getFont | () | method |
public function getFont():String
Returns the name of the font used for the label.
ReturnsString — The name of the font used.
|
getHAlign | () | method |
public function getHAlign():String
Returns the horizontal alignment for the textfield in the label.
ReturnsString — The horizontal alignment for the textfield in the label.
|
getHTMLEnabled | () | method |
public function getHTMLEnabled():Boolean
Returns whether the label renders its text as HTML.
ReturnsBoolean — True if the label renders its text as HTML.
|
getIsTruncated | () | method |
public function getIsTruncated():Boolean
Returns whether the label is currently truncated.
ReturnsBoolean — True if the label is currently truncated.
|
getMultiline | () | method |
public function getMultiline():Boolean
Returns whether the label is set to be multiline.
ReturnsBoolean — True if the label is multiline.
|
getText | () | method |
public function getText():String
Returns the current text in the label.
ReturnsString — The current text in the label.
|
getTextHeight | () | method |
public function getTextHeight():Number
Returns the current height of the textfield in the label.
ReturnsNumber — The pixel height of the textfield in the label.
|
getTextSize | () | method |
public function getTextSize():Number
Returns the font point size used for the label.
ReturnsNumber — The point size of the font.
|
getTextWidth | () | method |
public function getTextWidth():Number
Returns the current width of the textfield in the label.
ReturnsNumber — The pixel width of the textfield in the label.
|
getTruncate | () | method |
public function getTruncate():Boolean
Returns whether the label is set to truncate its text if the textfield is larger than the label size.
ReturnsBoolean — True if the label will truncate text based on the label size.
|
getType | () | method |
public function getType():String
Returns the label's type, which determines its style format.
ReturnsString — "body" or "title".
|
getUnderline | () | method |
public function getUnderline():Boolean
Returns whether the label is set to underline the text.
ReturnsBoolean — True if the label text should be underlined.
|
getVAlign | () | method |
public function getVAlign():String
Returns the vertical alignment for the textfield in the label.
ReturnsString — The vertical alignment for the textfield in the label.
|
setAutoSize | () | method |
public function setAutoSize(autoSize:Boolean):void
Sets whether the label should resize based on its text.
Parameters
autoSize:Boolean — if the label should resize based on its text.
|
setColor | () | method |
public function setColor(color:int):void
Sets a font color to be used instead of the style format's.
Parameters
color:int — value of the color to use.
|
setFont | () | method |
public function setFont(font:String):void
Sets a font to be used instead of the style format's.
Parameters
font:String — name of the font to use -- MUST be embedded, if the style format embeds the font.
|
setHAlign | () | method |
public function setHAlign(align:String):void
Sets the horizontal alignment for the textfield in the label.
Parameters
align:String — horizontal alignment for the textfield in the label.
|
setHTMLEnabled | () | method |
public function setHTMLEnabled(enabled:Boolean):void
Sets whether the label should render its text as HTML.
Parameters
enabled:Boolean — if the label should render its text as HTML.
|
setMultiline | () | method |
public function setMultiline(multiline:Boolean):void
Sets whether the label should display multiline.
Parameters
multiline:Boolean — if the label should display as multiline.
|
setText | () | method |
public function setText(text:String):void
Sets the current text for the label.
Parameters
text:String — text to apply to the label.
|
setTextSize | () | method |
public function setTextSize(size:Number):void
Sets a font size to be used instead of the style format's.
Parameters
size:Number — point size of the font.
|
setTruncate | () | method |
public function setTruncate(truncate:Boolean):void
Sets whether the label should truncate its text if the textfield is larger than the label size.
Parameters
truncate:Boolean — if the label should truncate text based on the label size.
|
setType | () | method |
public function setType(type:String):void
Sets the label's type, which determines its style format.
Parameters
type:String — or "title".
|
setUnderline | () | method |
public function setUnderline(underline:Boolean):void
Sets whether the label text should be underlined.
Parameters
underline:Boolean — if the label text should be underlined.
|
setVAlign | () | method |
public function setVAlign(align:String):void
Sets the vertical alignment for the textfield in the label.
Parameters
align:String — vertical alignment for the textfield in the label.
|