Package | com.brightcove.api.components |
Class | public class ToggleButton |
Inheritance | ToggleButton ![]() ![]() ![]() ![]() |
Method | Defined By | ||
---|---|---|---|
ToggleButton(element:Object)
Constructor. | ToggleButton | ||
![]() | 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. | Button | |
![]() | getBlendMode():String
Returns the blend mode of the component. | UIObject | |
![]() |
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. | Button | |
![]() | getHeight():Number
Returns the pixel height of the component. | Component | |
![]() | getIconAlignmentH():String
Returns the horizontal alignment for the icon. | Button | |
![]() | getIconAlignmentV():String
Returns the vertical alignment for the icon. | Button | |
![]() | getIconName():String
Returns the name of the current icon displayed. | Button | |
![]() | getIconOffsetX():Number
Returns the pixel amount on the x axis the icon is offset from its aligned position. | Button | |
![]() | getIconOffsetY():Number
Returns the pixel amount on the y axis the icon is offset from its aligned position. | Button | |
![]() | getIconScale():Number
Returns the percent scale at which to render the icon. | Button | |
![]() | 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 | |
getIsToggled():Boolean
Returns whether the button is currently in its toggled state. | ToggleButton | ||
![]() | getIsTruncated():Boolean
Returns whether the label is currently truncated. | Button | |
![]() | getLabel():String
Returns the current text in the label. | Button | |
![]() | getLabelAlignmentH():String
Returns the horizontal alignment for the label. | Button | |
![]() | getLabelAlignmentV():String
Returns the vertical alignment for the label. | Button | |
![]() | getLabelBuffer():Number
Returns the minimum pixel amount to the left and right of the label. | Button | |
![]() | getLabelOffsetX():Number
Returns the pixel amount on the x axis the label is offset from its aligned position. | Button | |
![]() | getLabelOffsetY():Number
Returns the pixel amount on the y axis the label is offset from its aligned position. | Button | |
![]() | getLabelSize():Number
Returns the font point size used for the label. | Button | |
![]() | getLabelWidth():Number
Returns the current width of the label. | Button | |
![]() | getMultiline():Boolean
Returns whether the label is set to be multiline. | Button | |
![]() | 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 | |
![]() | getShowBack():Boolean
Returns whether the background graphic for the button should be shown (if any is assigned through the theme). | Button | |
getToggledIconName():String
Returns the name of the icon displayed when component is toggled. | ToggleButton | ||
getToggledLabel():String
Returns the label when toggled. | ToggleButton | ||
getToggledTooltip():String
Returns the tooltip, if any, applied to the component when toggled. | ToggleButton | ||
![]() | getTooltip():String
Returns the tooltip, if any, applied to the component. | Button | |
![]() | getTruncateLabel():Boolean
Returns whether the label is set to truncate its text if the label is larger than the button size. | Button | |
![]() | 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. | Button | |
![]() | setBlendMode(mode:String):void
Sets the blend mode of the component. | UIObject | |
![]() | 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. | Button | |
![]() | setIconAlignmentH(alignment:String):void
Sets the horizontal alignment for the icon. | Button | |
![]() | setIconAlignmentV(alignment:String):void
Sets the vertical alignment for the icon. | Button | |
![]() | setIconName(name:String):void
Sets the current icon displayed. | Button | |
![]() | setIconOffsetX(offset:Number):void
Sets the pixel amount on the x axis the icon should be offset from its aligned position. | Button | |
![]() | setIconOffsetY(offset:Number):void
Sets the pixel amount on the y axis the icon should be offset from its aligned position. | Button | |
![]() | setIconScale(scale:Number):void
Sets the percent scale at which to render the icon. | Button | |
![]() | setIncludeInLayout(includeInLayout:Boolean):void
Sets whether the component is included in layout calculations and rendering in parent layout box. | Component | |
setIsToggled(toggled:Boolean):void
Sets whether the button is currently in its toggled state. | ToggleButton | ||
![]() | setLabel(label:String):void
Sets the current text for the label. | Button | |
![]() | setLabelAlignmentH(alignment:String):void
Sets the horizontal alignment for the label. | Button | |
![]() | setLabelAlignmentV(alignment:String):void
Sets the vertical alignment for the label. | Button | |
![]() | setLabelBuffer(buffer:Number):void
Sets the minimum pixel amount to the left and right of the label. | Button | |
![]() | setLabelOffsetX(offset:Number):void
Sets the pixel amount on the x axis the label should be offset from its aligned position. | Button | |
![]() | setLabelOffsetY(offset:Number):void
Sets the pixel amount on the y axis the label should be offset from its aligned position. | Button | |
![]() | setLabelSize(size:Number):void
Sets a font size to be used instead of the style format's. | Button | |
![]() | setMultiline(multiline:Boolean):void
Sets whether the label should display multiline. | Button | |
![]() | setRotation(rotation:Number):void
Sets the rotation of the component. | UIObject | |
![]() | setShowBack(show:Boolean):void
Sets whether the background graphic for the button should be shown (if any is assigned through the theme). | Button | |
![]() | 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 | |
setToggledIconName(iconName:String):void
Sets the icon displayed when component is toggled. | ToggleButton | ||
setToggledLabel(label:String):void
Sets the label when toggled. | ToggleButton | ||
setToggledTooltip(toolTip:String):void
Sets the tooltip for the component when toggled. | ToggleButton | ||
![]() | setTooltip(toolTip:String):void
Sets the tooltip for the component. | Button | |
![]() | setTruncateLabel(truncate:Boolean):void
Sets whether the label should truncate its text if the label is larger than the button size. | Button | |
![]() | setVisible(visible:Boolean):void
Sets whether the component is visible. | Component |
ToggleButton | () | Constructor |
public function ToggleButton(element:Object)
Constructor.
Parameterselement:Object — layout element to wrap and delegate all calls to.
|
getIsToggled | () | method |
public function getIsToggled():Boolean
Returns whether the button is currently in its toggled state.
ReturnsBoolean — True if the button is currently in its toggled state.
|
getToggledIconName | () | method |
public function getToggledIconName():String
Returns the name of the icon displayed when component is toggled.
ReturnsString — The name of the icon displayed when component is toggled.
|
getToggledLabel | () | method |
public function getToggledLabel():String
Returns the label when toggled.
ReturnsString — The label when toggled.
|
getToggledTooltip | () | method |
public function getToggledTooltip():String
Returns the tooltip, if any, applied to the component when toggled.
ReturnsString — Returns the string tooltip text when component is toggled.
|
setIsToggled | () | method |
public function setIsToggled(toggled:Boolean):void
Sets whether the button is currently in its toggled state.
Parameters
toggled:Boolean — to set the button in its toggled state.
|
setToggledIconName | () | method |
public function setToggledIconName(iconName:String):void
Sets the icon displayed when component is toggled.
Parameters
iconName:String — name of the icon to display when component is toggled.
|
setToggledLabel | () | method |
public function setToggledLabel(label:String):void
Sets the label when toggled.
Parameters
label:String — text to apply to the label when toggled.
|
setToggledTooltip | () | method |
public function setToggledTooltip(toolTip:String):void
Sets the tooltip for the component when toggled.
Parameters
toolTip:String — string to use for the tooltip text when component is toggled.
|