AbstractButton

Defines common behaviors for buttons and menu items.

@author paling @author ngrebenshikov

Class Fields

`static var BOTTOM:Int`

A fast access to AsWingConstants Constant @see org.aswing.AsWingConstants

`static var CENTER:Int`

A fast access to AsWingConstants Constant @see org.aswing.AsWingConstants

`static var HORIZONTAL:Int`

A fast access to AsWingConstants Constant @see org.aswing.AsWingConstants

`static var LEFT:Int`

A fast access to AsWingConstants Constant @see org.aswing.AsWingConstants

`static var RIGHT:Int`

A fast access to AsWingConstants Constant @see org.aswing.AsWingConstants

`static var TOP:Int`

A fast access to AsWingConstants Constant @see org.aswing.AsWingConstants

`static var VERTICAL:Int`

A fast access to AsWingConstants Constant @see org.aswing.AsWingConstants

Instance Fields

Show inherited public instance fields

Hide inherited public instance fields

Inherited from Component

var __fieldBindings__:FieldsBindSignal

var __methodBindings__:MethodsBindSignal

var alignmentX:Float

var alignmentY:Float

var background:ASColor

var backgroundDecorator:GroundDecorator

var border:Border

var bounds:IntRectangle

var clipBounds:IntRectangle

var constraints:Dynamic

var currentSize:IntDimension

var dragEnabled:Bool

var dropTrigger:Bool

var enabled:Bool

var focusable:Bool

var focusableSet:Bool

var font:ASFont

var foreground:ASColor

var foregroundDecorator:GroundDecorator

var location:IntPoint

var maximumSize:IntDimension

var mideground:ASColor

var minimumSize:IntDimension

var opaque:Bool

var opaqueSet:Bool

var preferredSize:IntDimension

var resizerMargin:Insets

var styleProxy:Component

var styleTune:StyleTune

var toolTipText:String

var transitFocusFactor:Float

var ui:ComponentUI

var uiElement:Bool

var visibility:Bool

function addDragAcceptableInitiator(com:Component):Void

function componentToGlobal(p:IntPoint):IntPoint

function getClientProperty(key:String, ?defaultValue:Dynamic):Dynamic

function getDefaultBasicUIClass():Class<Dynamic>

function getFocusManager():FocusManager

function getGlobalLocation(?rv:IntPoint):IntPoint

function getInsets():Insets

function getInternalFocusObject():InteractiveObject

function getKeyboardManager():KeyboardManager

function getMousePosition():IntPoint

function getPaintBounds():IntRectangle

function getParent():Container

function getRootPaneAncestor():JRootPane

function getUIClassID():String

function globalToComponent(p:IntPoint):IntPoint

function hitTestMouse():Bool

function invalidate():Void

function invalidatePreferSizeCaches():Void

function isCachePreferSizes():Bool

function isDragAcceptableInitiator(com:Component):Bool

function isFocusOwner():Bool

function isFontValidated():Bool

function isOnStage():Bool

function isShowing():Bool

function isValid():Bool

function isValidateRoot():Bool

function makeFocus():Void

function pack():Void

function paintFocusRect(?force:Bool):Void

function paintImmediately():Void

function parentReAppendChildren():Void

function putClientProperty(key:String, value:Dynamic):Void

function reAppendToParent(?constraints:Dynamic):Void

function removeDragAcceptableInitiator(com:Component):Void

function removeFromContainer():Void

function repaint():Void

function repaintAndRevalidate():Void

function requestFocus():Bool

function revalidate():Void

function setCachePreferSizes(b:Bool):Void

function setClipSize(size:IntDimension):Void

function setDragAcceptableInitiatorAppraiser(func:Dynamic ->Bool):Void

function setFontValidated(b:Bool):Void

function setGlobalLocation(gp:IntPoint):Void

function transferFocus():Bool

function transferFocusBackward():Bool

function updateUI():Void

function validate():Void

Inherited from AWSprite

function bringToBottom(child:DisplayObject):Void

function bringToTop(child:DisplayObject):Void

function containsChild(child:DisplayObject):Bool

function getHighestIndexUnderForeground():Int

function getLowestIndexAboveBackground():Int

function isClipMasked():Bool

function setChildIndex(child:DisplayObject, index:Int):Void

function setClipMaskRect(b:IntRectangle):Void

function setClipMasked(m:Bool):Void

function toString():String

Inherited from Sprite

var buttonMode:Bool

var dropTarget:DisplayObject

var graphics:Graphics

var hitArea:Sprite

var soundTransform:SoundTransform

var useHandCursor:Bool

function startDrag(?lockCenter:Bool, ?bounds:Rectangle):Void

function startTouchDrag(touchPointID:Int, ?lockCenter:Bool, ?bounds:Rectangle):Void

function stopDrag():Void

function stopTouchDrag(touchPointID:Int):Void

Inherited from DisplayObjectContainer

var mouseChildren:Bool

var numChildren:Int

var tabChildren:Bool

var textSnapshot:TextSnapshot

function addChild(child:DisplayObject):DisplayObject

function addChildAt(child:DisplayObject, index:Int):DisplayObject

function areInaccessibleObjectsUnderPoint(point:Point):Bool

function contains(child:DisplayObject):Bool

function getChildAt(index:Int):DisplayObject

function getChildByName(name:String):DisplayObject

function getChildIndex(child:DisplayObject):Int

function getObjectsUnderPoint(point:Point):Array<DisplayObject>

function removeChild(child:DisplayObject):DisplayObject

function removeChildAt(index:Int):DisplayObject

function setChildIndex(child:DisplayObject, index:Int):Void

function swapChildren(child1:DisplayObject, child2:DisplayObject):Void

function swapChildrenAt(index1:Int, index2:Int):Void

Inherited from InteractiveObject

var accessibilityImplementation:AccessibilityImplementation

var contextMenu:ContextMenu

var doubleClickEnabled:Bool

var focusRect:Dynamic

var mouseEnabled:Bool

var tabEnabled:Bool

var tabIndex:Int

Inherited from DisplayObject

var accessibilityProperties:AccessibilityProperties

var alpha:Float

var blendMode:BlendMode

var blendShader:Shader

var cacheAsBitmap:Bool

var filters:Array<BitmapFilter>

var height:Float

var loaderInfo:LoaderInfo

var mask:DisplayObject

var mouseX:Float

var mouseY:Float

var name:String

var opaqueBackground:Null<UInt>

var parent:DisplayObjectContainer

var root:DisplayObject

var rotation:Float

var rotationX:Float

var rotationY:Float

var rotationZ:Float

var scale9Grid:Rectangle

var scaleX:Float

var scaleY:Float

var scaleZ:Float

var scrollRect:Rectangle

var stage:Stage

var transform:Transform

var visible:Bool

var width:Float

var x:Float

var y:Float

var z:Float

function getBounds(targetCoordinateSpace:DisplayObject):Rectangle

function getRect(targetCoordinateSpace:DisplayObject):Rectangle

function globalToLocal(point:Point):Point

function globalToLocal3D(point:Point):Vector3D

function hitTestObject(obj:DisplayObject):Bool

function hitTestPoint(x:Float, y:Float, ?shapeFlag:Bool):Bool

function local3DToGlobal(point3d:Vector3D):Point

function localToGlobal(point:Point):Point

Inherited from EventDispatcher

function addEventListener(type:String, listener:Dynamic ->Void?useCapture:Bool, ?priority:Int, ?useWeakReference:Bool):Void

function dispatchEvent(event:Event):Bool

function hasEventListener(type:String):Bool

function removeEventListener(type:String, listener:Dynamic ->Void?useCapture:Bool):Void

function toString():String

function willTrigger(type:String):Bool

`var command:Command`

`var disabledIcon:Icon`

The disabled icon for the button.

`var disabledSelectedIcon:Icon`

The disabled selection icon for the button.

`var displayText:String`

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

`var horizontalAlignment:Int`

The horizontal alignment of the icon and text.

One of the following values:

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

`var horizontalTextPosition:Int`

The horizontal position of the text relative to the icon.

One of the following values:

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

`var icon:Icon`

`var iconTextGap:Int`

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.

`var iconTextGapSet:Bool`

True if iconTextGap is set by user.

`var margin:Insets`

The 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).

`var mnemonic:Int`

The keyboard mnemonic for this button, -1 means no mnemonic. @see #text @see #displayText @see #mnemonicIndex

`var mnemonicEnabled:Bool`

Whether or not enabled mnemonic.

`var mnemonicIndex:Int`

The mnemonic char index in the display text, -1 means no mnemonic. @see #text @see #displayText @see #mnemonic

`var model:ButtonModel`

The model that this button represents.

`var pressedIcon:Icon`

The pressed icon for the button.

`var rolloverEnabled:Bool`

`var rolloverIcon:Icon`

The rollover icon for the button.

`var rolloverSelectedIcon:Icon`

The rollover selected icon for the button.

`var selected:Bool`

The state of the button.

Note that setting does not trigger ACT Event for users (will of course trigger STATE_CHANGED event). Call this.doClick() to perform a programatic action change.

`var selectedIcon:Icon`

The selected icon for the button.

`var shiftOffset:Int`

The shift offset of the content when mouse press.

`var shiftOffsetSet:Bool`

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

`var text:String`

`var textFilters:Array<BitmapFilter>`

`var transitBackgroundFactor:Float`

`var verticalAlignment:Int`

`var verticalTextPosition:Int`

The vertical position of the text relative to the icon. One of the following values:

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

`function new(?text:String = '', ?icon:Icon = null): Void`

`function addActionListener(listener:Dynamic ->Void?priority:Int = 0, ?useWeakReference:Bool = false): Void`

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

See org.aswing.event.AWEvent#ACT

listener	the listener
priority	the priority
useWeakReference	Determines whether the reference to the listener is strong or weak.

`function addSelectionListener(listener:Dynamic ->Void?priority:Int = 0, ?useWeakReference:Bool = false): Void`

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

listener	the listener
priority	the priority
useWeakReference	Determines whether the reference to the listener is strong or weak. See `org.aswing.event.InteractiveEvent#SELECTION_CHANGED`

`function addStateListener(listener:Dynamic ->Void?priority:Int = 0, ?useWeakReference:Bool = false): Void`

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

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

this.enabled
this.rollOver
this.pressed
this.released
this.selected

@see org.aswing.event.InteractiveEvent#STATE_CHANGED

listener	the listener
priority	the priority
useWeakReference	Determines whether the reference to the listener is strong or weak.

`function doClick(): Void`

Programmatically perform a click.

`function removeActionListener(listener:Dynamic ->Void): Void`

Removes a action listener.

listener

the listener to be removed.

`function removeSelectionListener(listener:Dynamic ->Void): Void`

Removes a selection listener.

listener

the listener to be removed. See org.aswing.event.InteractiveEvent#SELECTION_CHANGED

`function removeStateListener(listener:Dynamic ->Void): Void`

Removes a state listener. @see org.aswing.event.InteractiveEvent#STATE_CHANGED

listener

the listener to be removed.

`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)));

`function wrapSimpleButton(btn:SimpleButton): AbstractButton`

Wrap a SimpleButton to be this button's representation.

btn	the SimpleButton to be wrap.
returns	the button self

class org.aswing.AbstractButton extends Component

Class Fields

static var BOTTOM:Int

static var CENTER:Int

static var HORIZONTAL:Int

static var LEFT:Int

static var RIGHT:Int

static var TOP:Int

static var VERTICAL:Int

Instance Fields

var command:Command

var disabledIcon:Icon

var disabledSelectedIcon:Icon

var displayText:String

var horizontalAlignment:Int

var horizontalTextPosition:Int

var icon:Icon

var iconTextGap:Int

var iconTextGapSet:Bool

var margin:Insets

var mnemonic:Int

var mnemonicEnabled:Bool

var mnemonicIndex:Int

var model:ButtonModel

var pressedIcon:Icon

var rolloverEnabled:Bool

var rolloverIcon:Icon

var rolloverSelectedIcon:Icon

var selected:Bool

var selectedIcon:Icon

var shiftOffset:Int

var shiftOffsetSet:Bool

var text:String

var textFilters:Array<BitmapFilter>

var transitBackgroundFactor:Float

var verticalAlignment:Int

var verticalTextPosition:Int

function new(?text:String = '', ?icon:Icon = null): Void

function addActionListener(listener:Dynamic ->Void?priority:Int = 0, ?useWeakReference:Bool = false): Void

function addSelectionListener(listener:Dynamic ->Void?priority:Int = 0, ?useWeakReference:Bool = false): Void

function addStateListener(listener:Dynamic ->Void?priority:Int = 0, ?useWeakReference:Bool = false): Void

function doClick(): Void

function removeActionListener(listener:Dynamic ->Void): Void

function removeSelectionListener(listener:Dynamic ->Void): Void

function removeStateListener(listener:Dynamic ->Void): Void

function updateUI(): Void

function wrapSimpleButton(btn:SimpleButton): AbstractButton

`class org.aswing.AbstractButton extends Component`

`static var BOTTOM:Int`

`static var CENTER:Int`

`static var HORIZONTAL:Int`

`static var LEFT:Int`

`static var RIGHT:Int`

`static var TOP:Int`

`static var VERTICAL:Int`

`var command:Command`

`var disabledIcon:Icon`

`var disabledSelectedIcon:Icon`

`var displayText:String`

`var horizontalAlignment:Int`

`var horizontalTextPosition:Int`

`var icon:Icon`

`var iconTextGap:Int`

`var iconTextGapSet:Bool`

`var margin:Insets`

`var mnemonic:Int`

`var mnemonicEnabled:Bool`

`var mnemonicIndex:Int`

`var model:ButtonModel`

`var pressedIcon:Icon`

`var rolloverEnabled:Bool`

`var rolloverIcon:Icon`

`var rolloverSelectedIcon:Icon`

`var selected:Bool`

`var selectedIcon:Icon`

`var shiftOffset:Int`

`var shiftOffsetSet:Bool`

`var text:String`

`var textFilters:Array<BitmapFilter>`

`var transitBackgroundFactor:Float`

`var verticalAlignment:Int`

`var verticalTextPosition:Int`

`function new(?text:String = '', ?icon:Icon = null): Void`

`function addActionListener(listener:Dynamic ->Void?priority:Int = 0, ?useWeakReference:Bool = false): Void`

`function addSelectionListener(listener:Dynamic ->Void?priority:Int = 0, ?useWeakReference:Bool = false): Void`

`function addStateListener(listener:Dynamic ->Void?priority:Int = 0, ?useWeakReference:Bool = false): Void`

`function doClick(): Void`

`function removeActionListener(listener:Dynamic ->Void): Void`

`function removeSelectionListener(listener:Dynamic ->Void): Void`

`function removeStateListener(listener:Dynamic ->Void): Void`

`function updateUI(): Void`

`function wrapSimpleButton(btn:SimpleButton): AbstractButton`