org.aswing.AbstractButton

	Property	Defined by
		cacheAsBitmap : Boolean	AWSprite
		container : Container	Component
		filters : Array	AWSprite
		height : Number	Component
		mask : DisplayObject	AWSprite
		numChildren : int	AWSprite
		visible : Boolean	Component
		width : Number	Component
		x : Number	Component
		y : Number	Component

	Property	Defined by
		bounds : IntRectangle	Component
		d_numChildren : int	AWSprite
		drawTransparentTrigger : Boolean = true	Component
		d_visible : Boolean Returns the `DisplayObject.visible` directly.	Component
		d_x : Number Returns `DisplayObject.x` directly.	Component
		d_y : Number Returns `DisplayObject.y` directly.	Component
		readyToPaint : Boolean	Component
		ui : ComponentUI	Component
		valid : Boolean	Component

Public Methods

	Method		Defined by
		AbstractButton(text:String = "", icon:Icon = null)	AbstractButton
		addActionListener(listener:Function, priority:int = 0, useWeakReference:Boolean = false):void Adds a action listener to this button.	AbstractButton
		addChild(dis:DisplayObject):DisplayObject Adds a child DisplayObject instance to this DisplayObjectContainer instance.	AWSprite
		addChildAt(child:DisplayObject, index:int):DisplayObject	AWSprite
		addDragAcceptableInitiator(com:Component):void Adds a component to be the acceptable drag initiator to this component.	Component
		addSelectionListener(listener:Function, priority:int = 0, useWeakReference:Boolean = false):void Add a listener to listen the button's selection change event.	AbstractButton
		addStateListener(listener:Function, priority:int = 0, useWeakReference:Boolean = false):void Adds a listener to listen the button's state change event.	AbstractButton
		bringToBottom(child:DisplayObject):void Brings a child to bottom.	AWSprite
		bringToTop(child:DisplayObject):void Brings a child to top.	AWSprite
		componentToGlobal(p:IntPoint):IntPoint	Component
		containsChild(child:DisplayObject):Boolean Returns whether child is directly child of this sprite, true only if getChildIndex(child) >= 0.	AWSprite
		doClick():void Programmatically perform a "click".	AbstractButton
		fireFocusKeyDownEvent(e:KeyboardEvent):void	Component
		fireFocusKeyUpEvent(e:KeyboardEvent):void	Component
		getAlignmentX():Number Returns the alignment along the x axis.	Component
		getAlignmentY():Number Returns the alignment along the y axis.	Component
		getAlpha():Number Returns the alpha of this component.	Component
		getAwmlID():String Returns ID used to identify components created from AWML.	Component
		getAwmlIndex():Number Returns position index of the component inside its AWML container.	Component
		getAwmlNamespace():String Returns namespace name used to identify components created from AWML.	Component
		getBackground():ASColor Gets the background color of this component.	Component
		getBackgroundDecorator():GroundDecorator Returns the background decorator of this component.	Component
		getBorder():Border Returns the border.	Component
		getBounds(targetCoordinateSpace:DisplayObject):Rectangle Same to DisplayObject.getBounds(), just add a explaination here that if you want to get the component bounds, see {	Component
		getChildAt(index:int):DisplayObject	AWSprite
		getChildByName(name:String):DisplayObject	AWSprite
		getChildIndex(child:DisplayObject):int	AWSprite
		getClientProperty(key:): Returns the value of the property with the specified key.	Component
		getClipBounds():IntRectangle Returns the clip bounds.	Component
		getComBounds(rv:IntRectangle = null):IntRectangle Stores the bounds value of this component into "return value" rv and returns rv.	Component
		getConstraints():Object Gets cpmponent's constraints.	Component
		getDefaultBasicUIClass():Class Returns the default basic ui class for this component.	Component
		getDisabledIcon():Icon Returns the icon used by the button when it's disabled.	AbstractButton
		getDisabledSelectedIcon():Icon Returns the icon used by the button when it's disabled and selected.	AbstractButton
		getDisplayText():String Returns the text to be displayed, it is a text that removed the "&"(mnemonic modifier char).	AbstractButton
		getFocusManager():FocusManager Returns the focus manager for this component's stage, or null if this component is not on stage.	Component
		getFont():ASFont Gets the font of this component.	Component
		getForeground():ASColor Gets the foreground color of this component.	Component
		getForegroundDecorator():GroundDecorator Returns the foreground decorator of this component.	Component
		getGlobalLocation(rv:IntPoint = null):IntPoint Stores the global location value of this component into "return value" p and returns p.	Component
		getHeight():int Returns the current height of this component	Component
		getHighestIndexUnderForeground():int Returns the current top index for a new child(none forground child).	AWSprite
		getHorizontalAlignment():int Returns the horizontal alignment of the icon and text.	AbstractButton
		getHorizontalTextPosition():int Returns the horizontal position of the text relative to the icon.	AbstractButton
		getIcon():Icon	AbstractButton
		getIconTextGap():int Returns the amount of space between the text and the icon displayed in this button.	AbstractButton
		getInsets():Insets If a border has been set on this component, returns the border's insets; otherwise returns an empty insets.	Component
		getInternalFocusObject():InteractiveObject Returns the object to receive the focus for this component.	Component
		getKeyboardManager():KeyboardManager Returns the keyboard manager of this component's `JRootPane` ancestor.	Component
		getLocation(rv:IntPoint = null):IntPoint Stores the location value of this component into "return value" rv and returns rv.	Component
		getLowestIndexAboveBackground():int Returns the current bottom index for none background child.	AWSprite
		getMargin():Insets	AbstractButton
		getMaximumHeight():int Returns `getMaximumSize().height`	Component
		getMaximumSize():IntDimension	Component
		getMaximumWidth():int Returns `getMaximumSize().width`	Component
		getMinimumHeight():int Returns `getMinimumSize().height`	Component
		getMinimumSize():IntDimension	Component
		getMinimumWidth():int Returns `getMinimumSize().width`	Component
		getMnemonic():int Returns the keyboard mnemonic for this button, -1 means no mnemonic.	AbstractButton
		getMnemonicIndex():int Returns the mnemonic char index in the display text, -1 means no mnemonic.	AbstractButton
		getModel():ButtonModel Returns the model that this button represents.	AbstractButton
		getMousePosition():IntPoint Returns the coordinate of the mouse position, in pixels, in the component scope.	Component
		getName():String Returns the name of the component	Component
		getPaintBounds():IntRectangle Returns the bounds that component should paint in.	Component
		getParent():Container Returns the `Container` parent, if it parent is not a `Container`, null will be returned.	Component
		getPreferredHeight():int Returns `getPreferredSize().height`	Component
		getPreferredSize():IntDimension	Component
		getPreferredWidth():int Returns `getPreferredSize().width`	Component
		getPressedIcon():Icon Returns the pressed icon for the button.	AbstractButton
		getRollOverIcon():Icon Returns the rollover icon for the button.	AbstractButton
		getRollOverSelectedIcon():Icon Returns the rollover selection icon for the button.	AbstractButton
		getRootPaneAncestor():JRootPane Returns the first `JRootPane` ancestor of this component.	Component
		getSelectedIcon():Icon Returns the selected icon for the button.	AbstractButton
		getShiftOffset():int Returns the shift offset when mouse press.	AbstractButton
		getSize(rv:IntDimension = null):IntDimension Stores the size value of this component into "return value" rv and returns rv.	Component
		getText():String Returns the text include the "&"(mnemonic modifier char).	AbstractButton
		getTextFilters():Array	AbstractButton
		getToolTipText():String Returns the tooltip string that has been set with setToolTipText.	Component
		getUI():ComponentUI	Component
		getUIClassID():String Returns the `UIDefaults` key used to look up the name of the `org.aswing.plaf.ComponentUI` class that defines the look and feel for this component.	Component
		getVerticalAlignment():int Returns the vertical alignment of the text and icon.	AbstractButton
		getVerticalTextPosition():int Returns the vertical position of the text relative to the icon.	AbstractButton
		getWidth():int Returns the current width of this component	Component
		getX():int Returns the current x coordinate of the components.	Component
		getY():int Returns the current y coordinate of the components.	Component
		globalToComponent(p:IntPoint):IntPoint	Component
		hitTestMouse():Boolean Returns whether the component hit the mouse.	Component
		hitTestObject(obj:DisplayObject):Boolean	AWSprite
		hitTestPoint(x:Number, y:Number, shapeFlag:Boolean = false):Boolean	AWSprite
		invalidate():void Invalidates this component.	Component
		invalidatePreferSizeCaches():void Clears this component and all parents above it's preferred size caches.	Component
		isCachePreferSizes():Boolean Returns whether or not the preferred size, minimum size and max size cache is turned on.	Component
		isClipMasked():Boolean Returns whether the component clip should be masked by its bounds.	AWSprite
		isDragAcceptableInitiator(com:Component):Boolean Returns whether the component is acceptable drag initiator for this component.	Component
		isDragEnabled():Boolean Returns whether this component can fire ON_DRAG_RECOGNIZED event.	Component
		isDropTrigger():Boolean Returns whether this component can trigger dragging component to fire drag events when dragging over to this component.(Default value is false)	Component
		isEnabled():Boolean Returns whether the component is enabled.	Component
		isFocusable():Boolean Returns whether this Component can be focused.	Component
		isFocusableSet():Boolean Returns whether or not the opaque property is set by user.	Component
		isFocusOwner():Boolean Returns `true` if this `Component` is the focus owner.	Component
		isFontValidated():Boolean Returns whether the new font are applied and taked effect.	Component
		isOnStage():Boolean Determines whether or not this component is on stage(on the display list).	Component
		isOpaque():Boolean Returns true if this component is completely opaque.	Component
		isOpaqueSet():Boolean Returns whether or not the opaque property is set by user.	Component
		isRollOverEnabled():Boolean Gets the `rolloverEnabled` property.	AbstractButton
		isSelected():Boolean Returns the state of the button.	AbstractButton
		isShiftOffsetSet():Boolean Return whether or not the shiftOffset has set by user.	AbstractButton
		isShowing():Boolean Determines whether this component is showing on screen.	Component
		isUIElement():Boolean Returns true if this component is just a ui element component, false means this component is a regular use created component.	Component
		isValid():Boolean Determines whether this component is valid.	Component
		isValidateRoot():Boolean If this method returns true, revalidate calls by descendants of this component will cause the entire tree beginning with this root to be validated.	Component
		isVisible():Boolean	Component
		makeFocus():void Makes this component's internal focus object to be the stage focus directly, without any judgement.	Component
		pack():void Causes this component to be sized to fit the preferred size.	Component
		paintFocusRect(force:Boolean = false):void Paints the focus rect if need.	Component
		paintImmediately():void Redraw the component UI face immediately if it is visible and ready to paint.	Component
		parentReAppendChildren():void Calls parent reAppendChildren if parent is a container.	Component
		putClientProperty(key:, value:):void Adds an arbitrary key/value "client property" to this component.	Component
		reAppendToParent(constraints:Object = null):void Removes this component from its parent and then append it with specified constraints.	Component
		removeActionListener(listener:Function):void Removes a action listener.	AbstractButton
		removeChild(child:DisplayObject):DisplayObject	AWSprite
		removeChildAt(index:int):DisplayObject	AWSprite
		removeDragAcceptableInitiator(com:Component):void Removes a component to be the acceptable drag initiator to this component.	Component
		removeFromContainer():void Removes this component from its parent, whatever it is as a component child or only a display object child, or it's parent is just a display object container.	Component
		removeSelectionListener(listener:Function):void Removes a selection listener.	AbstractButton
		removeStateListener(listener:Function):void Removes a state listener.	AbstractButton
		repaint():void Redraws the component face next RENDER event.This method can be called often, so it needs to execute quickly.	Component
		repaintAndRevalidate():void	Component
		requestFocus():Boolean Requests that this Component get the input focus, and that this Component's top-level ancestor become the focused Window.	Component
		revalidate():void Supports deferred automatic layout.	Component
		revalidateIfNecessary():void	Component
		setAlignmentX(ax:Number):void	Component
		setAlignmentY(ay:Number):void	Component
		setAlpha(alpha:Number):void Indicates the alpha transparency value of the component.	Component
		setAwmlID(id:String):void Sets ID used to identify components created from AWML.	Component
		setAwmlIndex(index:Number):void Sets ID used to identify components created from AWML.	Component
		setAwmlNamespace(theNamespace:String):void Sets namespace used to identify components created from AWML.	Component
		setBackground(c:ASColor):void Sets the background color of this component.	Component
		setBackgroundDecorator(bg:GroundDecorator):void Sets a decorator to be the component background, it will represent the component background with a `DisplayObject`.	Component
		setBorder(b:Border):void Sets the border for the component, null to remove border.	Component
		setBounds(b:IntRectangle):void This method will call setComBounds()	Component
		setCachePreferSizes(b:Boolean):void Sets whether or not turn on the preferred size, minimum size and max size cache.	Component
		setChildIndex(child:DisplayObject, index:int):void	AWSprite
		setClipBounds(b:IntRectangle):void Sets the clip bounds, a rectangle mask to make specified bounds visible.	Component
		setClipMasked(m:Boolean):void Sets whether the component clip should be masked by its bounds.	AWSprite
		setClipSize(size:IntDimension):void Sets the clip size, a rectangle mask to make specified bounds visible.	Component
		setComBounds(b:IntRectangle):void Moves and resizes this component.	Component
		setComBoundsXYWH(x:int, y:int, w:int, h:int):void Moves and resizes this component.	Component
		setConstraints(constraints:Object):void Sets component's constraints.	Component
		setDisabledIcon(disabledIcon:Icon):void Sets the disabled icon for the button.	AbstractButton
		setDisabledSelectedIcon(disabledSelectedIcon:Icon):void Sets the disabled selection icon for the button.	AbstractButton
		setDragAcceptableInitiatorAppraiser(func:Function):void Sets a function to judge whether a component is acceptable drag initiator.	Component
		setDragEnabled(b:Boolean):void Sets whether this component can fire ON_DRAG_RECOGNIZED event.	Component
		setDropTrigger(b:Boolean):void Sets whether this component can trigger dragging component to fire drag events when dragging over to this component.	Component
		setEnabled(b:Boolean):void Enabled (or disabled) the button.	AbstractButton
		setFocusable(b:Boolean):void Sets the focusable state of this Component to the specified value.	Component
		setFocusableSet(b:Boolean):void Indicate that the `focusable` property is set by user or not.	Component
		setFont(newFont:ASFont):void Sets the text font for this component. this method will cause a repaint and revalidate method call.	Component
		setFontValidated(b:Boolean):void Sets whether the new font are applied and taked effect.	Component
		setForeground(c:ASColor):void Sets the foreground color of this component.	Component
		setForegroundDecorator(fg:GroundDecorator):void Sets a decorator to be the component foreground, it will represent the component foreground with a `DisplayObject` on top of other children of this component.	Component
		setGlobalLocation(gp:IntPoint):void Set the component's location in global coordinate.	Component
		setGlobalLocationXY(x:int, y:int):void Set the component's location in global coordinate.	Component
		setHeight(height:Number):void Sets the component's height.	Component
		setHorizontalAlignment(alignment:int):void Sets the horizontal alignment of the icon and text.	AbstractButton
		setHorizontalTextPosition(textPosition:int):void Sets the horizontal position of the text relative to the icon.	AbstractButton
		setIcon(defaultIcon:Icon):void Sets the default icon for the button.	AbstractButton
		setIconTextGap(iconTextGap:int):void If both the icon and text properties are set, this property defines the space between them.	AbstractButton
		setLocation(newPos:IntPoint):void Set the component's location, if it is diffs from old location, invalidate it to wait validate.	Component
		setLocationXY(x:int, y:int):void	Component
		setMargin(m:Insets):void Sets space for margin between the button's border and the label.	AbstractButton
		setMaximumHeight(maximumHeight:int):void Sets maximum height, -1 means auto count.	Component
		setMaximumSize(maximumSize:IntDimension):void setMaximumSize(d:IntDimension) setMaximumSize(width:Number, height:Number) Set the maximumSize, then the component's maximumSize is specified.	Component
		setMaximumWidth(maximumWidth:int):void Sets maximum width, -1 means auto count.	Component
		setMinimumHeight(minimumHeight:int):void Sets minimum height, -1 means auto count.	Component
		setMinimumSize(minimumSize:IntDimension):void setMinimumSize(d:IntDimension) setMinimumSize(width:Number, height:Number) Set the minimumSize, then the component's minimumSize is specified.	Component
		setMinimumWidth(minimumWidth:int):void Sets minimum width, -1 means auto count.	Component
		setModel(newModel:ButtonModel):void Sets the model that this button represents.	AbstractButton
		setName(name:String):void Sets the name of this component	Component
		setOpaque(b:Boolean):void If true the component paints every pixel within its bounds.	Component
		setOpaqueSet(b:Boolean):void This method will be called to set true when you set the opaque by `setOpaque()`.	Component
		setPreferredHeight(preferredHeight:int):void Sets preferred width, -1 means auto count.	Component
		setPreferredSize(preferredSize:IntDimension):void setPreferredSize(d:IntDimension) setPreferredSize(width:Number, height:Number) Set the preferredSize, then the component's preferredSize is specified.	Component
		setPreferredWidth(preferredWidth:int):void Sets preferred width, -1 means auto count.	Component
		setPressedIcon(pressedIcon:Icon):void Sets the pressed icon for the button.	AbstractButton
		setRollOverEnabled(b:Boolean):void Sets the `rolloverEnabled` property, which must be `true` for rollover effects to occur.	AbstractButton
		setRollOverIcon(rolloverIcon:Icon):void Sets the rollover icon for the button.	AbstractButton
		setRollOverSelectedIcon(rolloverSelectedIcon:Icon):void Sets the rollover selected icon for the button.	AbstractButton
		setSelected(b:Boolean):void Sets the state of the button.	AbstractButton
		setSelectedIcon(selectedIcon:Icon):void Sets the selected icon for the button.	AbstractButton
		setShiftOffset(shiftOffset:int):void Set the shift offset when mouse press.	AbstractButton
		setShiftOffsetSet(b:Boolean):void Set whether or not the shiftOffset has set by user.	AbstractButton
		setSize(newSize:IntDimension):void Set the component's size, the width and height all will be setted to not less than zero, then set the size.	Component
		setSizeWH(w:int, h:int):void	Component
		setText(text:String):void Sets the text include the "&"(mnemonic modifier char).	AbstractButton
		setTextFilters(fs:Array):void	AbstractButton
		setToolTipText(t:String):void Registers the text to display in a tool tip.	Component
		setUI(newUI:ComponentUI):void Sets the look and feel delegate for this component.	Component
		setUIElement(b:Boolean):void Sets the component is a ui element or not.	Component
		setVerticalAlignment(alignment:int):void Sets the vertical alignment of the icon and text.	AbstractButton
		setVerticalTextPosition(textPosition:int):void Sets the vertical position of the text relative to the icon.	AbstractButton
		setVisible(v:Boolean):void Set a component to be hide or shown.	Component
		setWidth(width:int):void Sets the component's width.	Component
		setX(x:int):void Sets the x coordinate of the components.	Component
		setY(y:int):void Sets the y coordinate of the components.	Component
		swapChildren(child1:DisplayObject, child2:DisplayObject):void	AWSprite
		swapChildrenAt(index1:int, index2:int):void	AWSprite
		toString():String	Component
		transferFocus():Boolean Transfers the focus to the next component, as though this Component were the focus owner.	Component
		transferFocusBackward():Boolean Transfers the focus to the previous component, as though this Component were the focus owner.	Component
		updateUI():void Resets the UI property to a value from the current look and feel.	AbstractButton
		validate():void Ensures that this component has a valid layout.	Component
		wrapSimpleButton(btn:SimpleButton):AbstractButton Wrap a SimpleButton to be this button's representation.	AbstractButton

	Method	Defined by
		clearPreferSizeCaches():void	Component
		countMaximumSize():IntDimension get the maximumSize from ui, if ui is null then return a big dimension;	Component
		countMinimumSize():IntDimension get the minimumSize from ui, if ui is null then Returns getInsets().roundsSize(new IntDimension(0, 0)).	Component
		countPreferredSize():IntDimension get the preferredSize from ui, if ui is null then just return the current size	Component
		d_addChild(child:DisplayObject):DisplayObject	AWSprite
		d_addChildAt(child:DisplayObject, index:int):DisplayObject	AWSprite
		d_getChildAt(index:int):DisplayObject	AWSprite
		d_getChildByName(name:String):DisplayObject	AWSprite
		d_getChildIndex(child:DisplayObject):int	AWSprite
		d_removeChild(child:DisplayObject):DisplayObject	AWSprite
		d_removeChildAt(index:int):DisplayObject	AWSprite
		d_setChildIndex(child:DisplayObject, index:int):void	AWSprite
		d_swapChildren(child1:DisplayObject, child2:DisplayObject):void	AWSprite
		d_swapChildrenAt(index1:int, index2:int):void	AWSprite
		getBackgroundChild():DisplayObject Returns the background child.	AWSprite
		getFocusTransmit():Component Override this to return another component that the focus should be transmit to.	Component
		getForegroundChild():DisplayObject Returns the foreground child.	AWSprite
		installIcon(icon:Icon):void	AbstractButton
		invalidateTree():void Makes this component and all parents above it are marked as needing to be laid out.	Component
		isChild(child:DisplayObject):Boolean Returns whether or not the child is this sprite's direct child.	AWSprite
		locate():void Locate the component to the current location.	Component
		paint(b:IntRectangle):void draw the component interface in specified bounds.	Component
		setBackgroundChild(child:DisplayObject = null):void Sets the child to be the component background, it will be add to the bottom of all other children.	AWSprite
		setClipMaskRect(b:IntRectangle):void	AWSprite
		setForegroundChild(child:DisplayObject = null):void Sets the child to be the component foreground, it will be add to the top of all other children.	AWSprite
		size():void Do the process when size changed.	Component
		uninstallIcon(icon:Icon):void	AbstractButton

Summary	Defined by
act	Dispatched when the button's model take action, generally when user click the button or `doClick()` method is called.	AbstractButton
clickCount	Dispatched when the component is clicked continuesly.	Component
dragDrop	Dispatched when a drag is drop on this component.	Component
dragEnter	Dispatched when a drag is enter this component area.	Component
dragExit	Dispatched when a drag is exit this component area.	Component
dragRecongnized	Dispatched when the component is recongnized that it can be drag start.	Component
focusGained	Dispatched when the component gained the focus from it is not the focus owner	Component
focusKeyDown	Dispatched when the key down and the component is the focus owner.	Component
focusKeyUp	Dispatched when the key up and the component is the focus owner.	Component
focusLost	Dispatched when the component lost the focus from it was the focus owner.	Component
hidden	Dispatched when the component visible is set to false from true.	Component
moved	Dispatched when the component is moved.	Component
paint	Dispatched when the component is painted.	Component
release	Dispatched when the mouse released or released out side.	AWSprite
releaseOutSide	Dispatched only when the mouse released out side.	AWSprite
resized	Dispatched when the component is resized.	Component
selectionChanged	Dispatched when the button's selection changed.	AbstractButton
shown	Dispatched when the component visible is set to true from false.	Component
stateChanged	Dispatched when the button's state changed.	AbstractButton

	Constant	Defined by
		BOTTOM : int = 3 [static] A fast access to AsWingConstants Constant	AbstractButton
		CENTER : int = 0 [static] A fast access to AsWingConstants Constant	AbstractButton
		HORIZONTAL : int = 0 [static] A fast access to AsWingConstants Constant	AbstractButton
		LEFT : int = 2 [static] A fast access to AsWingConstants Constant	AbstractButton
		RIGHT : int = 4 [static] A fast access to AsWingConstants Constant	AbstractButton
		TOP : int = 1 [static] A fast access to AsWingConstants Constant	AbstractButton
		VERTICAL : int = 1 [static] A fast access to AsWingConstants Constant	AbstractButton

Constructor detail

AbstractButton

()

constructor

public function AbstractButton(text:String = "", icon:Icon = null)Parameters

	`text:String` (default = "")

	`icon:Icon` (default = `null`)

Method detail

addActionListener

()

method

public function addActionListener(listener:Function, priority:int = 0, useWeakReference:Boolean = false):void

Adds a action listener to this button. Buttons fire a action event when user clicked on it.

Parameters

	`listener:Function` — the listener

	`priority:int` (default = `0`) — the priority

	`useWeakReference:Boolean` (default = `false`) — Determines whether the reference to the listener is strong or weak.

See also

org.aswing.event.AWEvent.ACT

addSelectionListener

()

method

public function addSelectionListener(listener:Function, priority:int = 0, useWeakReference:Boolean = false):void

Add a listener to listen the button's selection change event. When the button's selection changed, fired when diselected or selected.

Parameters

	`listener:Function` — the listener

	`priority:int` (default = `0`) — the priority

	`useWeakReference:Boolean` (default = `false`) — Determines whether the reference to the listener is strong or weak.

See also

org.aswing.event.InteractiveEvent.SELECTION_CHANGED

addStateListener

()

method

public function addStateListener(listener:Function, priority:int = 0, useWeakReference:Boolean = false):void

Adds a listener to listen the button's state change event.

When the button's state changed, the state is all about:

enabled
rollOver
pressed
released
selected

Parameters

	`listener:Function` — the listener

	`priority:int` (default = `0`) — the priority

	`useWeakReference:Boolean` (default = `false`) — Determines whether the reference to the listener is strong or weak.

See also

org.aswing.event.InteractiveEvent.STATE_CHANGED

doClick

()

method

public function doClick():void

Programmatically perform a "click".

getDisabledIcon

()

method

public function getDisabledIcon():Icon

Returns the icon used by the button when it's disabled. If no disabled icon has been set, the button constructs one from the default icon.

The disabled icon really should be created (if necessary) by the L&F.-->

Returns

Icon — the disabledIcon property

See also

getPressedIcon()
setDisabledIcon()

getDisabledSelectedIcon

()

method

public function getDisabledSelectedIcon():Icon

Returns the icon used by the button when it's disabled and selected. If not no disabled selection icon has been set, the button constructs one from the selection icon.

The disabled selection icon really should be created (if necessary) by the L&F. -->

Returns

Icon — the disabledSelectedIcon property

See also

getPressedIcon()
setDisabledIcon()

getDisplayText

()

method

public function getDisplayText():String

Returns the text to be displayed, it is a text that removed the "&"(mnemonic modifier char).

Returns

String — the text to be displayed.

getHorizontalAlignment

()

method

public function getHorizontalAlignment():int

Returns the horizontal alignment of the icon and text.

Returns

int — the horizontalAlignment property, one of the following values:

AsWingConstants.RIGHT (the default)
AsWingConstants.LEFT
AsWingConstants.CENTER

getHorizontalTextPosition

()

method

public function getHorizontalTextPosition():int

Returns the horizontal position of the text relative to the icon.

Returns

int — the horizontalTextPosition property, one of the following values:

AsWingConstants.RIGHT (the default)
AsWingConstants.LEFT
AsWingConstants.CENTER

getIcon

()

method

public function getIcon():Icon

Returns

Icon

getIconTextGap

()

method

public function getIconTextGap():int

Returns the amount of space between the text and the icon displayed in this button.

Returns

int — an int equal to the number of pixels between the text and the icon.

See also

setIconTextGap()

getMargin

()

method

public function getMargin():Insets

Returns

Insets

getMnemonic

()

method

public function getMnemonic():int

Returns the keyboard mnemonic for this button, -1 means no mnemonic.

Returns

int — the keyboard mnemonic or -1.

getMnemonicIndex

()

method

public function getMnemonicIndex():int

Returns the mnemonic char index in the display text, -1 means no mnemonic.

Returns

int — the mnemonic char index or -1.

See also

getDisplayText()

getModel

()

method

public function getModel():ButtonModel

Returns the model that this button represents.

Returns

ButtonModel — the model property

See also

setModel()

getPressedIcon

()

method

public function getPressedIcon():Icon

Returns the pressed icon for the button.

Returns

Icon — the pressedIcon property

See also

setPressedIcon()

getRollOverIcon

()

method

public function getRollOverIcon():Icon

Returns the rollover icon for the button.

Returns

Icon — the rolloverIcon property

See also

setRollOverIcon()

getRollOverSelectedIcon

()

method

public function getRollOverSelectedIcon():Icon

Returns the rollover selection icon for the button.

Returns

Icon — the rolloverSelectedIcon property

See also

setRollOverSelectedIcon()

getSelectedIcon

()

method

public function getSelectedIcon():Icon

Returns the selected icon for the button.

Returns

Icon — the selectedIcon property

See also

setSelectedIcon()

getShiftOffset

()

method

public function getShiftOffset():int

Returns the shift offset when mouse press.

Returns

int — the shift offset when mouse press.

getText

()

method

public function getText():String

Returns the text include the "&"(mnemonic modifier char).

Returns

String — the text.

See also

getDisplayText()

getTextFilters

()

method

public function getTextFilters():Array

Returns

Array

getVerticalAlignment

()

method

public function getVerticalAlignment():int

Returns the vertical alignment of the text and icon.

Returns

int — the verticalAlignment property, one of the following values:

AsWingConstants.CENTER (the default)
AsWingConstants.TOP
AsWingConstants.BOTTOM

getVerticalTextPosition

()

method

public function getVerticalTextPosition():int

Returns the vertical position of the text relative to the icon.

Returns

int — the verticalTextPosition property, one of the following values:

AsWingConstants.CENTER (the default)
AsWingConstants.TOP
AsWingConstants.BOTTOM

installIcon

()

method

protected function installIcon(icon:Icon):voidParameters

icon:Icon

isRollOverEnabled

()

method

public function isRollOverEnabled():Boolean

Gets the rolloverEnabled property.

Returns

Boolean — the value of the rolloverEnabled property

See also

setRollOverEnabled()

isSelected

()

method

public function isSelected():Boolean

Returns the state of the button. True if the toggle button is selected, false if it's not.

Returns

Boolean — true if the toggle button is selected, otherwise false

isShiftOffsetSet

()

method

public function isShiftOffsetSet():Boolean

Return whether or not the shiftOffset has set by user. The LAF will not change this value if it is true.

Returns

Boolean

removeActionListener

()

method

public function removeActionListener(listener:Function):void

Removes a action listener.

Parameters

listener:Function — the listener to be removed.

See also

org.aswing.event.AWEvent.ACT

removeSelectionListener

()

method

public function removeSelectionListener(listener:Function):void

Removes a selection listener.

Parameters

listener:Function — the listener to be removed.

See also

org.aswing.event.InteractiveEvent.SELECTION_CHANGED

removeStateListener

()

method

public function removeStateListener(listener:Function):void

Removes a state listener.

Parameters

listener:Function — the listener to be removed.

See also

org.aswing.event.InteractiveEvent.STATE_CHANGED

setDisabledIcon

()

method

public function setDisabledIcon(disabledIcon:Icon):void

Sets the disabled icon for the button.

Parameters

disabledIcon:Icon — the icon used as the disabled image

See also

getDisabledIcon()

setDisabledSelectedIcon

()

method

public function setDisabledSelectedIcon(disabledSelectedIcon:Icon):void

Sets the disabled selection icon for the button.

Parameters

disabledSelectedIcon:Icon — the icon used as the disabled selection image

See also

getDisabledSelectedIcon()

setEnabled

()

method

public override function setEnabled(b:Boolean):void

Enabled (or disabled) the button.

Parameters

b:Boolean — true to enable the button, otherwise false

setHorizontalAlignment

()

method

public function setHorizontalAlignment(alignment:int):void

Sets the horizontal alignment of the icon and text.

Parameters

alignment:int — one of the following values:

AsWingConstants.RIGHT (the default)
AsWingConstants.LEFT
AsWingConstants.CENTER

setHorizontalTextPosition

()

method

public function setHorizontalTextPosition(textPosition:int):void

Sets the horizontal position of the text relative to the icon.

Parameters

textPosition:int — one of the following values:

AsWingConstants.RIGHT (the default)
AsWingConstants.LEFT
AsWingConstants.CENTER

setIcon

()

method

public function setIcon(defaultIcon:Icon):void

Sets the default icon for the button.

This method will make button repaint, but will not make button relayout, so if you sets a different size icon, you may need to call revalidate() to make this button to be relayouted by his container.

Parameters

defaultIcon:Icon — the default icon for the button.

setIconTextGap

()

method

public function setIconTextGap(iconTextGap:int):void

If both the icon and text properties are set, this property defines the space between them.

The default value of this property is 4 pixels. Parameters

iconTextGap:int

See also

getIconTextGap()

setMargin

()

method

public function setMargin(m:Insets):void

Sets space for margin between the button's border and the label. Setting to null will cause the button to use the default margin. The button's default Border object will use this value to create the proper margin. However, if a non-default border is set on the button, it is that Border object's responsibility to create the appropriate margin space (else this property will effectively be ignored).

Parameters

m:Insets — the space between the border and the label

setModel

()

method

public function setModel(newModel:ButtonModel):void

Sets the model that this button represents.

Parameters

newModel:ButtonModel — the new ButtonModel

See also

getModel()

setPressedIcon

()

method

public function setPressedIcon(pressedIcon:Icon):void

Sets the pressed icon for the button.

Parameters

pressedIcon:Icon — the icon used as the "pressed" image

See also

getPressedIcon()

setRollOverEnabled

()

method

public function setRollOverEnabled(b:Boolean):void

Sets the rolloverEnabled property, which must be true for rollover effects to occur. The default value for the rolloverEnabled property is false. Some look and feels might not implement rollover effects; they will ignore this property.

Parameters

b:Boolean — if true, rollover effects should be painted

See also

isRollOverEnabled()

setRollOverIcon

()

method

public function setRollOverIcon(rolloverIcon:Icon):void

Sets the rollover icon for the button.

Parameters

rolloverIcon:Icon — the icon used as the "rollover" image

See also

getRollOverIcon()

setRollOverSelectedIcon

()

method

public function setRollOverSelectedIcon(rolloverSelectedIcon:Icon):void

Sets the rollover selected icon for the button.

Parameters

rolloverSelectedIcon:Icon — the icon used as the "selected rollover" image

See also

getRollOverSelectedIcon()

setSelected

()

method

public function setSelected(b:Boolean):void

Sets the state of the button. Note that this method does not trigger an Event for users. Call click to perform a programatic action change.

Parameters

b:Boolean — true if the button is selected, otherwise false

setSelectedIcon

()

method

public function setSelectedIcon(selectedIcon:Icon):void

Sets the selected icon for the button.

Parameters

selectedIcon:Icon — the icon used as the "selected" image

See also

getSelectedIcon()

setShiftOffset

()

method

public function setShiftOffset(shiftOffset:int):void

Set the shift offset when mouse press.

Parameters

shiftOffset:int

setShiftOffsetSet

()

method

public function setShiftOffsetSet(b:Boolean):void

Set whether or not the shiftOffset has set by user. The LAF will not change this value if it is true.

Parameters

b:Boolean

setText

()

method

public function setText(text:String):void

Sets the text include the "&"(mnemonic modifier char). For example, if you set "&File" to be the text, then "File" will be displayed, and "F" will be the mnemonic.

This method will make button repaint, but will not make button relayout, so if you sets a different size text, you may need to call revalidate() to make this button to be relayouted by his container.

Parameters

text:String — the text.

setTextFilters

()

method

public function setTextFilters(fs:Array):voidParameters

fs:Array

setVerticalAlignment

()

method

public function setVerticalAlignment(alignment:int):void

Sets the vertical alignment of the icon and text.

Parameters

alignment:int — one of the following values:

AsWingConstants.CENTER (the default)
AsWingConstants.TOP
AsWingConstants.BOTTOM

setVerticalTextPosition

()

method

public function setVerticalTextPosition(textPosition:int):void

Sets the vertical position of the text relative to the icon.

Parameters

textPosition:int — one of the following values:

AsWingConstants.CENTER (the default)
AsWingConstants.TOP
AsWingConstants.BOTTOM

uninstallIcon

()

method

protected function uninstallIcon(icon:Icon):voidParameters

icon:Icon

updateUI

()

method

public override function updateUI():void

Resets the UI property to a value from the current look and feel. Subtypes of AbstractButton should override this to update the UI. For example, JButton might do the following:

          setUI(ButtonUI(UIManager.getUI(this)));

wrapSimpleButton

()

method

public function wrapSimpleButton(btn:SimpleButton):AbstractButton

Wrap a SimpleButton to be this button's representation.

Parameters

btn:SimpleButton — the SimpleButton to be wrap.

Returns

AbstractButton — the button self

Event detail

act

event

Event object type: org.aswing.event.AWEvent
AWEvent.type property = org.aswing.event.AWEvent.ACT

Dispatched when the button's model take action, generally when user click the button or doClick() method is called.

The AWEvent.ACT constant defines the value of the type property of the event object for a act event.

The properties of the event object have the following values:

Property	Value
`bubbles`	false
`cancelable`	false
`currentTarget`	The Object that defines the event listener that handles the event. For example, if you use `comp.addEventListener()` to register an event listener, comp is the value of the `currentTarget`.
`target`	The Object that dispatched the event; it is not always the Object listening for the event. Use the `currentTarget` property to always access the Object listening for the event.

selectionChanged

event

Event object type: org.aswing.event.InteractiveEvent
InteractiveEvent.type property = org.aswing.event.InteractiveEvent.SELECTION_CHANGED

Dispatched when the button's selection changed.

Buttons always fire programmatic=false InteractiveEvent.

The InteractiveEvent.SELECTION_CHANGED constant defines the value of the type property of the event object for a selectionChanged event.

The properties of the event object have the following values:

Property	Value
`bubbles`	false
`cancelable`	false
`isProgrammatic()`	True means this event is fired by the programmatic reason, false means user mouse/keyboard interaction reason.
`currentTarget`	The Object that defines the event listener that handles the event. For example, if you use `comp.addEventListener()` to register an event listener, comp is the value of the `currentTarget`.
`target`	The Object that dispatched the event; it is not always the Object listening for the event. Use the `currentTarget` property to always access the Object listening for the event.

stateChanged

event

Event object type: org.aswing.event.InteractiveEvent
InteractiveEvent.type property = org.aswing.event.InteractiveEvent.STATE_CHANGED

Dispatched when the button's state changed. the state is all about:

enabled
rollOver
pressed
released
selected

Buttons always fire programmatic=false InteractiveEvent.

The InteractiveEvent.STATE_CHANGED constant defines the value of the type property of the event object for a stateChanged event.

The properties of the event object have the following values:

Property	Value
`bubbles`	false
`cancelable`	false
`isProgrammatic()`	True means this event is fired by the programmatic reason, false means user mouse/keyboard interaction reason.
`currentTarget`	The Object that defines the event listener that handles the event. For example, if you use `comp.addEventListener()` to register an event listener, comp is the value of the `currentTarget`.
`target`	The Object that dispatched the event; it is not always the Object listening for the event. Use the `currentTarget` property to always access the Object listening for the event.

Constant detail

BOTTOM

constant

public static const BOTTOM:int = 3