org.aswing.Component

	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

	Method	Defined by
		Component()	Component
		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
		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
		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
		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
		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
		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
		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
		getRootPaneAncestor():JRootPane Returns the first `JRootPane` ancestor of this component.	Component
		getSize(rv:IntDimension = null):IntDimension Stores the size value of this component into "return value" rv and returns rv.	Component
		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
		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
		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
		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
		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
		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 Enable or disable the component.	Component
		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
		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
		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
		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
		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
		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
		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.	Component
		validate():void Ensures that this component has a valid layout.	Component

	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
		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

Summary	Defined by
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
shown	Dispatched when the component visible is set to true from false.	Component

Property detail

bounds

property

protected var bounds:IntRectangle

container

property

public var container:Container

drawTransparentTrigger

property

protected var drawTransparentTrigger:Boolean = true

d_visible

property

d_visible:Boolean [read-write]

Returns the DisplayObject.visible directly.

Implementation
protected function get d_visible():Boolean
protected function set d_visible(value:Boolean):void

d_x

property

d_x:Number [read-write]

Returns DisplayObject.x directly.

Implementation
protected function get d_x():Number
protected function set d_x(value:Number):void

d_y

property

d_y:Number [read-write]

Returns DisplayObject.y directly.

Implementation
protected function get d_y():Number
protected function set d_y(value:Number):void

height

property

height:Number [read-write]

Implementation
public function get height():Number
public function set height(value:Number):void

See also

getHeight()

readyToPaint

property

protected var readyToPaint:Boolean

property

protected var ui:ComponentUI

valid

property

protected var valid:Boolean

visible

property

visible:Boolean  [read-write]Implementation
    public function get visible():Boolean
    public function set visible(value:Boolean):void

width

property

width:Number [read-write]

Implementation
public function get width():Number
public function set width(value:Number):void

See also

getWidth()

property

x:Number [read-write]

Implementation
public function get x():Number
public function set x(value:Number):void

See also

getX()

property

y:Number [read-write]

Implementation
public function get y():Number
public function set y(value:Number):void

See also

getY()

Constructor detail

Component

()

constructor

public function Component()

Method detail

addDragAcceptableInitiator

()

method

public function addDragAcceptableInitiator(com:Component):void

Adds a component to be the acceptable drag initiator to this component.

It is not meanning that the DnD events will not be fired when the initiator is dragging enter/over/exit/drop on this component. It is meanning that you can have a convenient way to proccess that events from the method isDragAcceptableInitiator later, and the default dragging image will take advantage to present a better picture when painting.

Parameters

com:Component — the acceptable drag initiator

See also

isDragAcceptableInitiator()

clearPreferSizeCaches

()

method

protected function clearPreferSizeCaches():void

componentToGlobal

()

method

public function componentToGlobal(p:IntPoint):IntPointParameters

p:IntPoint

Returns

IntPoint

countMaximumSize

()

method

protected function countMaximumSize():IntDimension

get the maximumSize from ui, if ui is null then return a big dimension;

Returns

IntDimension

See also

IntDimension.createBigDimension()

countMinimumSize

()

method

protected function countMinimumSize():IntDimension

get the minimumSize from ui, if ui is null then Returns getInsets().roundsSize(new IntDimension(0, 0)).

Returns

IntDimension

countPreferredSize

()

method

protected function countPreferredSize():IntDimension

get the preferredSize from ui, if ui is null then just return the current size

Returns

IntDimension

fireFocusKeyDownEvent

()

method

public function fireFocusKeyDownEvent(e:KeyboardEvent):voidParameters

e:KeyboardEvent

fireFocusKeyUpEvent

()

method

public function fireFocusKeyUpEvent(e:KeyboardEvent):voidParameters

e:KeyboardEvent

getAlignmentX

()

method

public function getAlignmentX():Number

Returns the alignment along the x axis. This specifies how the component would like to be aligned relative to its size when its size is maxer than its maximumSize. The value should be a number between 0 and 1 where 0 represents alignment start from left, 1 is aligned the furthest away from the left, 0.5 is centered, etc.

Returns

Number — the alignment along the x axis, 0 by default

getAlignmentY

()

method

public function getAlignmentY():Number

Returns the alignment along the y axis. This specifies how the component would like to be aligned relative to its size when its size is maxer than its maximumSize. The value should be a number between 0 and 1 where 0 represents alignment start from top, 1 is aligned the furthest away from the top, 0.5 is centered, etc.

Returns

Number — the alignment along the y axis, 0 by default

getAlpha

()

method

public function getAlpha():Number

Returns the alpha of this component.

Returns

Number — the alpha of this component. default is 1.

getAwmlID

()

method

public function getAwmlID():String

Returns ID used to identify components created from AWML.

Returns

String — the AWML ID

getAwmlIndex

()

method

public function getAwmlIndex():Number

Returns position index of the component inside its AWML container.

Returns

Number — the component index in the AWML

getAwmlNamespace

()

method

public function getAwmlNamespace():String

Returns namespace name used to identify components created from AWML.

Returns

String — the namespace name

getBackground

()

method

public function getBackground():ASColor

Gets the background color of this component.

Returns

ASColor — this component's background color; if this component does not have a background color and it has parent, the background color of its parent is returned

See also

setBackground()

getBackgroundDecorator

()

method

public function getBackgroundDecorator():GroundDecorator

Returns the background decorator of this component.

Returns

GroundDecorator — the background decorator of this component.

getBorder

()

method

public function getBorder():Border

Returns the border.

Returns

Border — the border.

getBounds

()

method

public override function getBounds(targetCoordinateSpace:DisplayObject):Rectangle

Same to DisplayObject.getBounds(), just add a explaination here that if you want to get the component bounds, see {

Parameters

targetCoordinateSpace:DisplayObject

Returns

Rectangle

See also

getComBounds()
setComBounds()

getClientProperty

()

method

public function getClientProperty(key:*):*

Returns the value of the property with the specified key. Only properties added with putClientProperty will return a non-null value.

Parameters

key:* — the being queried

Returns

* — the value of this property or null

See also

putClientProperty()

getClipBounds

()

method

public function getClipBounds():IntRectangle

Returns the clip bounds.

Returns

IntRectangle

See also

setClipBounds()

getComBounds

()

method

public function getComBounds(rv:IntRectangle = null):IntRectangle

Stores the bounds value of this component into "return value" rv and returns rv. If rv is null a new IntRectangle object is allocated. Parameters

rv:IntRectangle (default = null) — the return value, modified to the component's bounds.

Returns

IntRectangle

See also

setSize()
setLocation()

getConstraints

()

method

public function getConstraints():Object

Gets cpmponent's constraints.

Returns

Object — component's constraints

getDefaultBasicUIClass

()

method

public function getDefaultBasicUIClass():Class

Returns the default basic ui class for this component. If there is not a ui class specified in L&F for this component, this method will be called to return a default one.

Returns

Class — the default basic ui class.

getFocusManager

()

method

public function getFocusManager():FocusManager

Returns the focus manager for this component's stage, or null if this component is not on stage.

Returns

FocusManager

getFocusTransmit

()

method

protected function getFocusTransmit():Component

Override this to return another component that the focus should be transmit to. return null if do not need to transmit(means self handle the focus). By default imp, this return null.

Returns

Component — the component where the focus need transmit to.

getFont

()

method

public function getFont():ASFont

Gets the font of this component.

Returns

ASFont — this component's font; if a font has not been set for this component and it has parent, the font of its parent is returned

See also

setFont()

getForeground

()

method

public function getForeground():ASColor

Gets the foreground color of this component.

Returns

ASColor — this component's foreground color; if this component does not have a foreground color and it has parent, the foreground color of its parent is returned

See also

setForeground()

getForegroundDecorator

()

method

public function getForegroundDecorator():GroundDecorator

Returns the foreground decorator of this component.

Returns

GroundDecorator — the foreground decorator of this component.

getGlobalLocation

()

method

public function getGlobalLocation(rv:IntPoint = null):IntPoint

Stores the global location value of this component into "return value" p and returns p. If p is null a new Point object is allocated.

Parameters

rv:IntPoint (default = null) — the return value, modified to the component's global location.

Returns

IntPoint

See also

getLocation()
setGlobalLocation()
MovieClip.localToGlobal()
MovieClip.globalToLocal()

getHeight

()

method

public function getHeight():int

Returns the current height of this component

Returns

int — the height of the component

getInsets

()

method

public function getInsets():Insets

If a border has been set on this component, returns the border's insets; otherwise returns an empty insets.

Returns

Insets

getInternalFocusObject

()

method

public function getInternalFocusObject():InteractiveObject

Returns the object to receive the focus for this component. It will call the ui to return the ui specified object, if ui is null or ui returned null, then it just return the component self.

Other component may return a child object, for example JTextComponent will return its TextField object.


     
Returns


InteractiveObject — the object to receive the focus.
     



See also


org.aswing.plaf.ComponentUI.getInternalFocusObject()





getKeyboardManager () method  



public function getKeyboardManager():KeyboardManager
  Returns the keyboard manager of this component's JRootPane ancestor.
  

Returns


KeyboardManager — 
                        the keyboard manager, or null if no root pane ancestor.
  
                        
                     






getLocation () method  



public function getLocation(rv:IntPoint = null):IntPoint
  Stores the location value of this component into "return value" rv and returns rv. 
  If p is null a new Point object is allocated. 
  
Parameters


rv:IntPoint (default = null) — the return value, modified to the component's location.
  



Returns


IntPoint






getMaximumHeight () method  



public function getMaximumHeight():int
  Returns getMaximumSize().height
  

Returns


int



See also


getMaximumSize()





getMaximumSize () method  



public function getMaximumSize():IntDimension
  

Returns


IntDimension



See also


setMaximumSize()





getMaximumWidth () method  



public function getMaximumWidth():int
  Returns getMaximumSize().width
  

Returns


int



See also


getMaximumSize()





getMinimumHeight () method  



public function getMinimumHeight():int
  Returns getMinimumSize().height
  

Returns


int



See also


getMinimumSize()





getMinimumSize () method  



public function getMinimumSize():IntDimension
  

Returns


IntDimension



See also


setMinimumSize()





getMinimumWidth () method  



public function getMinimumWidth():int
  Returns getMinimumSize().width
  

Returns


int



See also


getMinimumSize()





getMousePosition () method  



public function getMousePosition():IntPoint
     Returns the coordinate of the mouse position, in pixels, in the component scope.
     

Returns


IntPoint — 
                        the coordinate of the mouse position.
     
                        
                     






getName () method  



public function getName():String
  Returns the name of the component
  

Returns


String



See also


name





getPaintBounds () method  



public function getPaintBounds():IntRectangle
  Returns the bounds that component should paint in.
  

  This is same to some paint method param b:Rectangle.
  So if you want to paint outside those method, you can get the 
  rectangle from here.
  
  If this component has a little maximum size, and then current 
  size is larger, the bounds return from this method will be related 
  to getAlignmentX, getAlignmentY and getMaximumSize.
  

Returns


IntRectangle — 
                        return the rectangle that component should paint in.
  
                        
                     



See also


getAlignmentX()


getAlignmentY()


getMaximumSize()





getParent () method  



public function getParent():Container
  Returns the Container parent, 
  if it parent is not a Container, null will be returned.
  

Returns


Container — 
                        the Container parent
  
                        
                     






getPreferredHeight () method  



public function getPreferredHeight():int
  Returns getPreferredSize().height
  

Returns


int



See also


getPreferredSize()





getPreferredSize () method  



public function getPreferredSize():IntDimension
  

Returns


IntDimension



See also


setPreferredSize()





getPreferredWidth () method  



public function getPreferredWidth():int
  Returns getPreferredSize().width
  

Returns


int



See also


getPreferredSize()





getRootPaneAncestor () method  



public function getRootPaneAncestor():JRootPane
  Returns the first JRootPane ancestor of this component.
  

Returns


JRootPane — 
                        the JRootPane ancestor, or null if not found.
  
                        
                     






getSize () method  



public function getSize(rv:IntDimension = null):IntDimension
  Stores the size value of this component into "return value" rv and returns rv. 
  If rv is null a new IntDimension object is allocated. 
  
Parameters


rv:IntDimension (default = null) — the return value, modified to the component's size.
  



Returns


IntDimension






getToolTipText () method  



public function getToolTipText():String
  Returns the tooltip string that has been set with setToolTipText. 
  

Returns


String — the text of the tool tip
  



See also


setToolTipText()





getUI () method  



public function getUI():ComponentUI

Returns


ComponentUI






getUIClassID () method  



public function 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.  Most applications will never need to
     call this method.  Subclasses of Component that support
     pluggable look and feel should override this method to
     return a UIDefaults key that maps to the
     ComponentUI subclass that defines their look and feel.
          

Returns


String — the UIDefaults key for a
      ComponentUI subclass
     



See also


org.aswing.UIDefaults.getUI()





getWidth () method  



public function getWidth():int
  Returns the current width of this component
  

Returns


int — the width of the component
  






getX () method  



public function getX():int
  Returns the current x coordinate of the components.
  

Returns


int — the current x coordinate of the components
  



See also


getLocation()





getY () method  



public function getY():int
  Returns the current y coordinate of the components.
  

Returns


int — the current y coordinate of the components
  



See also


getLocation()





globalToComponent () method  



public function globalToComponent(p:IntPoint):IntPointParameters


p:IntPoint



Returns


IntPoint






hitTestMouse () method  



public function hitTestMouse():Boolean
  Returns whether the component hit the mouse.
  

Returns


Boolean






invalidate () method  



public function invalidate():void
     Invalidates this component.  This component and all parents
     above it are marked as needing to be laid out, and all clearPreferSizeCaches.
     This method can be called often, so it needs to execute quickly.
     

See also


../aswing/Component.html#validate()


../aswing/Component.html#doLayout()


../aswing/Component.html#invalidatePreferSizeCaches()


../aswing/LayoutManager.html





invalidatePreferSizeCaches () method  



public function invalidatePreferSizeCaches():void
     Clears this component and all parents above it's preferred size caches.
     

     By default all components' prefer sizes(max, min, prefer) have caches, if you 
     make some call that cached a invalided component's sizes but then you modifid 
     the component again, so it's prefer size need to be renew, 
     invalidatePreferSizeCaches will be helpful now.
     
     
     Generally you do not need to call this method manually unless you get above situation.
     this method will be called inside invalidate() automatically.
     
     
See also


../aswing/Component.html#invalidate()


../aswing/Component.html#validate()


../aswing/Component.html#setCachePreferSizes()


../aswing/LayoutManager.html





invalidateTree () method  



protected function invalidateTree():void
     Makes this component and all parents
     above it are marked as needing to be laid out.
  



isCachePreferSizes () method  



public function isCachePreferSizes():Boolean
  Returns whether or not the preferred size, minimum size and 
  max size cache is turned on.
  

Returns


Boolean — whether or not the preferred size, minimum size and 
  max size cache is turned on.
  






isDragAcceptableInitiator () method  



public function isDragAcceptableInitiator(com:Component):Boolean
  Returns whether the component is acceptable drag initiator for this component.
  
Parameters


com:Component — the maybe acceptable drag initiator
  



Returns


Boolean — true if it is acceptable drag initiator, false not
  






isDragEnabled () method  



public function isDragEnabled():Boolean
  Returns whether this component can fire ON_DRAG_RECOGNIZED event. (Default value is false)
  

Returns


Boolean



See also


ON_DRAG_RECOGNIZED


setDragEnabled()





isDropTrigger () method  



public function isDropTrigger():Boolean
  Returns whether this component can trigger dragging component to fire drag events 
  when dragging over to this component.(Default value is false)
  

Returns


Boolean — true if this component is a trigger that can trigger drag and drop action to 
  fire events, false it is not.
  



See also


ON_DRAG_ENTER


ON_DRAG_OVER


ON_DRAG_EXIT


ON_DRAG_DROP


setDropTrigger()





isEnabled () method  



public function isEnabled():Boolean
  Returns whether the component is enabled.
  

Returns


Boolean



See also


setEnabled()





isFocusable () method  



public function isFocusable():Boolean
     Returns whether this Component can be focused.
          

Returns


Boolean — true if this Component is focusable;
             false otherwise.
     



See also


setFocusable()





isFocusableSet () method  



public function isFocusableSet():Boolean
     Returns whether or not the opaque property is set by user. 
     If it is not set, focusable will can be replaced with the value defined 
     in LAF defaults when install a UI.
     

Returns


Boolean






isFocusOwner () method  



public function isFocusOwner():Boolean
     Returns true if this Component is the 
        focus owner.
          

Returns


Boolean — true if this Component is the 
         focus owner; false otherwise
     






isFontValidated () method  



public function isFontValidated():Boolean
  Returns whether the new font are applied and taked effect.
  

  Some UI can just apply font to text when this method returned false 
  to avoid wasteful time for font applying.
  

Returns


Boolean — true if currently font are applied to texts, otherwish false.
  



See also


setFontValidated()





isOnStage () method  



public function isOnStage():Boolean
  Determines whether or not this component is on stage(on the display list).
  

Returns


Boolean — turn of this component is on display list, false not.
  






isOpaque () method  



public function isOpaque():Boolean
     Returns true if this component is completely opaque.
     

     An opaque component paints every pixel within its
     rectangular bounds. A non-opaque component paints only a subset of
     its pixels or none at all, allowing the pixels underneath it to
     "show through".  Therefore, a component that does not fully paint
     its pixels provides a degree of transparency.
     
     
     The value is from LAF defaults if you have not set it.
     
     
     Subclasses that guarantee to always completely paint their contents
     should override this method and return true.
     

     

Returns


Boolean — true if this component is completely opaque
     



See also


setOpaque()


isOpaqueSet()





isOpaqueSet () method  



public function isOpaqueSet():Boolean
     Returns whether or not the opaque property is set by user. 
     If it is not set, opaque will can be replaced with the value defined 
     in LAF defaults when install a UI.
     

Returns


Boolean






isShowing () method  



public function isShowing():Boolean
     Determines whether this component is showing on screen. This means
     that the component must be visible, and it must be in a container
     that is visible and showing.
     

Returns


Boolean — true if the component is showing,
              false otherwise
     



See also


setVisible()





isUIElement () method  



public function isUIElement():Boolean
     Returns true if this component is just a ui element component, 
     false means this component is a regular use created component.
     

     If a component is a ui element, it and its children will not be called 
     updateUI() when AsWingUtils to go thought a list of component to update the UI.
     That is because ui element will be removed when uninstall UI, new ui elements 
     will be created when install UI. So it do not need to do update.
     
     
Returns


Boolean — whether or not this component is a ui element component.
     



See also


AsWingUtils#updateChildrenUI()


setUIElement()





isValid () method  



public function isValid():Boolean
     Determines whether this component is valid. A component is valid
     when it is correctly sized within its parent
     container and all its children are also valid. components are invalidated
     before they are first shown on the screen. By the time the parent container 
     is fully realized, all its components will be valid.
     

Returns


Boolean — true if the component is valid, false
     otherwise
     



See also


validate()


invalidate()





isValidateRoot () method  



public function 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. 
  Returns false by default. 
  JScrollPane overrides this method and returns true. 
  

Returns


Boolean — return true if this component is located in a non-component container, 
          otherwise returns false
  






isVisible () method  



public function isVisible():Boolean

Returns


Boolean






locate () method  



protected function locate():void
  Locate the component to the current location.
  



makeFocus () method  



public function makeFocus():void
     Makes this component's internal focus object to be the stage focus directly, 
     without any judgement.
     

     You'd better to call requestFocus() generally, this method is only 
     used to some internal implementation at most time.
     
     
See also


requestFocus()


getInternalFocusObject()





pack () method  



public function pack():void
  Causes this component to be sized to fit the preferred size.
  



paint () method  



protected function paint(b:IntRectangle):void
  draw the component interface in specified bounds.
  Sub class should override this method if you want to draw your component's face.
  
Parameters


b:IntRectangle — this paiting bounds, it is opposite on the component corrdinarry.
  






paintFocusRect () method  



public function paintFocusRect(force:Boolean = false):void
  Paints the focus rect if need.
  The focus will be paint by the component ui if this component is focusOwner and 
  FocusManager.getCurrentManager().isTraversing().
  
Parameters


force:Boolean (default = false) — force to paint the focus rect nomatter if it is focused.
  






paintImmediately () method  



public function paintImmediately():void
  Redraw the component UI face immediately if it is visible and ready to paint.
  

See also


repaint()


isVisible()


isReadyToPaint()





parentReAppendChildren () method  



public function parentReAppendChildren():void
  Calls parent reAppendChildren if parent is a container.
  

See also


Container.reAppendChildren()





putClientProperty () method  



public function putClientProperty(key:*, value:*):void
     Adds an arbitrary key/value "client property" to this component.
     

     The get/putClientProperty methods provide access to 
     a small per-instance hashtable. Callers can use get/putClientProperty
     to annotate components that were created by another module.
     For example, a
     layout manager might store per child constraints this way. For example:
     
     componentA.putClientProperty("to the left of", componentB);
     
     Parameters


key:* — the new client property key
     


 


value:* — the new client property value
     



See also


getClientProperty()





reAppendToParent () method  



public function reAppendToParent(constraints:Object = null):void
  Removes this component from its parent and then append it with specified constraints.
  If this component is not in a container yet, no effect will take.
  
Parameters


constraints:Object (default = null) — the new constraints, null means get from getConstraints method.
  



See also


getConstraints





removeDragAcceptableInitiator () method  



public function removeDragAcceptableInitiator(com:Component):void
  Removes a component to be the acceptable drag initiator to this component.
  
Parameters


com:Component — the acceptable drag initiator
  



See also


addDragAcceptableInitiator()





removeFromContainer () method  



public function 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.
  

  This method will remove this component in any case.
  
  



repaint () method  



public function repaint():void
  Redraws the component face next RENDER event.This method can
     be called often, so it needs to execute quickly.
  

See also


org.aswing.RepaintManager





repaintAndRevalidate () method  



public function repaintAndRevalidate():void




requestFocus () method  



public function requestFocus():Boolean
     Requests that this Component get the input focus, and that this
     Component's top-level ancestor become the focused Window. This component
     must be displayable, visible, and focusable for the request to be
     granted. Every effort will be made to honor the request; however, in
     some cases it may be impossible to do so. Developers must never assume
     that this Component is the focus owner until this Component receives a
     ON_FOCUS_GAINED event.
          

Returns


Boolean — true if the request is made successful, false if the request is denied.
     



See also


isFocusable()


isDisplayable()


ON_FOCUS_GAINED





revalidate () method  



public function revalidate():void
     Supports deferred automatic layout.  
     
 
     Calls invalidateLayout and then adds this component's
     validateRoot to a list of components that need to be
     validated.  Validation will occur after all currently pending
     events have been dispatched.  In other words after this method
     is called,  the first validateRoot (if any) found when walking
     up the containment hierarchy of this component will be validated.
     By default, JPopup, JScrollPane,
     and JTextField return true 
     from isValidateRoot.
     

     This method will or will not automatically be called on this component 
     when a property value changes such that size, location, or 
     internal layout of this component has been affected.But invalidate
     will do called after thats method, so you want to get the contents of 
     the GUI to update you should call this method.
     

          

See also


invalidate()


validate()


isValidateRoot()


RepaintManager.addInvalidComponent()





revalidateIfNecessary () method  



public function revalidateIfNecessary():void




setAlignmentX () method  



public function setAlignmentX(ax:Number):void
  
Parameters


ax:Number



See also


getAlignmentX()





setAlignmentY () method  



public function setAlignmentY(ay:Number):void
  
Parameters


ay:Number



See also


getAlignmentY()





setAlpha () method  



public function setAlpha(alpha:Number):void
     Indicates the alpha transparency value of the component. 
     Valid values are 0 (fully transparent) to 1 (fully opaque).
     
Parameters


alpha:Number — the alpha for this component, between 0 and 1. default is 1.
     






setAwmlID () method  



public function setAwmlID(id:String):void
  Sets ID used to identify components created from AWML. Used to obtain components through 
  {
Parameters


id:String — the component's AWML ID
  






setAwmlIndex () method  



public function setAwmlIndex(index:Number):void
  Sets ID used to identify components created from AWML. Used to obtain components through 
  {
Parameters


index:Number — the position index of the component
  






setAwmlNamespace () method  



public function setAwmlNamespace(theNamespace:String):void
  Sets namespace used to identify components created from AWML. 
  Used to obtain components through {
Parameters


theNamespace:String — the new namespace name
  






setBackground () method  



public function setBackground(c:ASColor):void
     Sets the background color of this component.
     

     The background color affects each component differently.
          Parameters


c:ASColor — the color to become this component's color;
              if this parameter is null and it has parent, then this
              component will inherit the background color of its parent
     



See also


getBackground()





setBackgroundDecorator () method  



public function setBackgroundDecorator(bg:GroundDecorator):void
  Sets a decorator to be the component background, it will represent the component background 
  with a DisplayObject. null to remove the decorator set before.
  
  
Parameters


bg:GroundDecorator — the background decorator.
  






setBorder () method  



public function setBorder(b:Border):void
  Sets the border for the component, null to remove border.
  
Parameters


b:Border — the new border to set, or null.
  






setBounds () method  



public function setBounds(b:IntRectangle):void
  This method will call setComBounds()
  
Parameters


b:IntRectangle



See also


setComBounds()





setCachePreferSizes () method  



public function setCachePreferSizes(b:Boolean):void
  Sets whether or not turn on the preferred size, minimum size and 
  max size cache. By default, this is true(means turned on).
  

  If this is turned on, the size count will be very fast as most time. 
  So suggest you that do not turn off it unless you have your personal reason.
  
  Parameters


b:Boolean — true to turn on it, false trun off it.
  






setClipBounds () method  



public function setClipBounds(b:IntRectangle):void
  Sets the clip bounds, a rectangle mask to make specified bounds visible.
  Null to make the componet mask whole rectangle(show all).
  
Parameters


b:IntRectangle — the bounds to be the masked clip, null to make it show all. Default is null.
  






setClipSize () method  



public function setClipSize(size:IntDimension):void
  Sets the clip size, a rectangle mask to make specified bounds visible.
  This will be only in effect after component created and before next layout time.
  
Parameters


size:IntDimension



See also


setClipBounds()





setComBounds () method  



public function setComBounds(b:IntRectangle):void
  Moves and resizes this component. The new location of the top-left corner is specified by x and y, and the new size is specified by width and height. 
  
Parameters


b:IntRectangle — the location and size bounds
  






setComBoundsXYWH () method  



public function setComBoundsXYWH(x:int, y:int, w:int, h:int):void
  Moves and resizes this component. The new location of the top-left corner is specified by x and y, and the new size is specified by width and height. 
  
Parameters


x:int


 


y:int


 


w:int


 


h:int






setConstraints () method  



public function setConstraints(constraints:Object):void
  Sets component's constraints.
  
Parameters


constraints:Object — the constraints to set
  






setDragAcceptableInitiatorAppraiser () method  



public function setDragAcceptableInitiatorAppraiser(func:Function):void
  Sets a function to judge whether a component is acceptable drag initiator.
  This function will be called to judge when dragAcceptableInitiator set 
  does not contains the component.
  
Parameters


func:Function — judge function
  






setDragEnabled () method  



public function setDragEnabled(b:Boolean):void
  Sets whether this component can fire ON_DRAG_RECOGNIZED event.
  
Parameters


b:Boolean



See also


ON_DRAG_RECOGNIZED


isDragEnabled()





setDropTrigger () method  



public function setDropTrigger(b:Boolean):void
  Sets whether this component can trigger dragging component to fire drag events 
  when dragging over to this component.
  
Parameters


b:Boolean — true to make this component to be a trigger that trigger drag and drop 
  action to fire events, false not to do that things.
  



See also


ON_DRAG_ENTER


ON_DRAG_OVER


ON_DRAG_EXIT


ON_DRAG_DROP


isDropTrigger()





setEnabled () method  



public function setEnabled(b:Boolean):void
  Enable or disable the component.
  

  If a component is disabled, it will not fire mouse events. 
  And some component will has different interface when enabled or disabled.
  Parameters


b:Boolean — true to enable the component, false to disable it.
  






setFocusable () method  



public function setFocusable(b:Boolean):void
     Sets the focusable state of this Component to the specified value. This
     value overrides the Component's default focusability.
          
Parameters


b:Boolean — indicates whether this Component is focusable
     



See also


isFocusable()





setFocusableSet () method  



public function setFocusableSet(b:Boolean):void
  Indicate that the focusable property is set by user or not.
  
Parameters


b:Boolean — whether set or not
  



See also


isFocusableSet()





setFont () method  



public function setFont(newFont:ASFont):void
  Sets the text font for this component.

  this method will cause a repaint and revalidate method call.

  
Parameters


newFont:ASFont — the font to set for this component.
  






setFontValidated () method  



public function setFontValidated(b:Boolean):void
  Sets whether the new font are applied and taked effect.
  

  Once the UI applied the font, it can call this method to set the value 
  to be true, to avoid next wasteful applying.
  Parameters


b:Boolean



See also


isFontValidated()





setForeground () method  



public function setForeground(c:ASColor):void
     Sets the foreground color of this component.
     

     The foreground color affects each component differently.
          Parameters


c:ASColor — the color to become this component's color;
              if this parameter is null and it has parent, then this
              component will inherit the foreground color of its parent
     



See also


getForeground()





setForegroundDecorator () method  



public function 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. 
  null to remove the decorator set before.
  
  
Parameters


fg:GroundDecorator — the foreground decorator.
  






setGlobalLocation () method  



public function setGlobalLocation(gp:IntPoint):void
  Set the component's location in global coordinate. This method should only be called when the component 
  is on the display list.
  
Parameters


gp:IntPoint — the global location.
  



See also


setLocation()


localToGlobal()


MovieClip.globalToLocal()





setGlobalLocationXY () method  



public function setGlobalLocationXY(x:int, y:int):void
  Set the component's location in global coordinate. This method should only be called when the component 
  is on the display list.
  
Parameters


x:int — the global x location.
  


 


y:int — the global y location.
  



See also


setLocation()


localToGlobal()


globalToLocal()





setHeight () method  



public function setHeight(height:Number):void
  Sets the component's height.
  
Parameters


height:Number — the height of component to set
  



See also


../aswing/Component.html#setSize()





setLocation () method  



public function setLocation(newPos:IntPoint):void
  Set the component's location, if it is diffs from old location, invalidate it to wait validate.
  The top-left corner of the new location is specified by the x and y parameters 
  in the coordinate space of this component's parent.
  
Parameters


newPos:IntPoint






setLocationXY () method  



public function setLocationXY(x:int, y:int):void
  
Parameters


x:int


 


y:int



See also


setLocation()





setMaximumHeight () method  



public function setMaximumHeight(maximumHeight:int):void
  Sets maximum height, -1 means auto count.
  
Parameters


maximumHeight:int



See also


setMaximumSize()





setMaximumSize () method  



public function setMaximumSize(maximumSize:IntDimension):void
  setMaximumSize(d:IntDimension)

  setMaximumSize(width:Number, height:Number)

  

  Set the maximumSize, then the component's maximumSize is
  specified. otherwish getMaximumSize will can count method.
  
  Parameters


maximumSize:IntDimension — null to set maximumSize null to make getMaximumSize will can the layout.
  others set the maximumSize to be a specified size.
  



See also


getMaximumSize()


MaximumSize()





setMaximumWidth () method  



public function setMaximumWidth(maximumWidth:int):void
  Sets maximum width, -1 means auto count.
  
Parameters


maximumWidth:int



See also


setMaximumSize()





setMinimumHeight () method  



public function setMinimumHeight(minimumHeight:int):void
  Sets minimum height, -1 means auto count.
  
Parameters


minimumHeight:int



See also


setMinimumSize()





setMinimumSize () method  



public function setMinimumSize(minimumSize:IntDimension):void
  setMinimumSize(d:IntDimension)

  setMinimumSize(width:Number, height:Number)
  

  Set the minimumSize, then the component's minimumSize is
  specified. otherwish getMinimumSize will can the count method.
  Parameters


minimumSize:IntDimension — null to set minimumSize null then getMinimumSize will can the layout.
  others set the minimumSize to be a specified size.
  



See also


getMinimumSize()





setMinimumWidth () method  



public function setMinimumWidth(minimumWidth:int):void
  Sets minimum width, -1 means auto count.
  
Parameters


minimumWidth:int



See also


setMinimumSize()





setName () method  



public function setName(name:String):void
  Sets the name of this component
  
Parameters


name:String



See also


name





setOpaque () method  



public function setOpaque(b:Boolean):void
     If true the component paints every pixel within its bounds. 
     Otherwise, the component may not paint some or all of its
     pixels, allowing the underlying pixels to show through.
     

     The default value of this property is false for JComponent.
     However, the default value for this property on most standard
     Component subclasses (such as JButton and
     JTree) is look-and-feel dependent.
          Parameters


b:Boolean —  true if this component should be opaque
     



See also


isOpaque()





setOpaqueSet () method  



public function setOpaqueSet(b:Boolean):void
     This method will be called to set true when you set the opaque by setOpaque().
     You can also call this method to make the opaque property returned by the set or LAF defaults.
     
Parameters


b:Boolean



See also


isOpaqueSet()


isOpaque()





setPreferredHeight () method  



public function setPreferredHeight(preferredHeight:int):void
  Sets preferred width, -1 means auto count.
  
Parameters


preferredHeight:int



See also


setPreferredSize()





setPreferredSize () method  



public function setPreferredSize(preferredSize:IntDimension):void
  setPreferredSize(d:IntDimension)

  setPreferredSize(width:Number, height:Number)

  

  Set the preferredSize, then the component's preferredSize is
  specified. otherwish getPreferredSize will count method.
  
  Parameters


preferredSize:IntDimension — null to set preferredSize null to make getPreferredSize will call the layout,
  others set the preferredSize to be a specified size.
  



See also


getPreferredSize()





setPreferredWidth () method  



public function setPreferredWidth(preferredWidth:int):void
  Sets preferred width, -1 means auto count.
  
Parameters


preferredWidth:int



See also


setPreferredSize()





setSize () method  



public function 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.
  You can set a Component's size max than its maximumSize, but when it was drawed,
   it will not max than its maximumSize.Just as its maximumSize and posited itself
   in that size dimension you just setted. The position is relative to getAlignmentX 
  
Parameters


newSize:IntDimension



See also


getAlignmentX()


getAlignmentY()


getMinimumSize()


countMaximumSize()


getPreferredSize()





setSizeWH () method  



public function setSizeWH(w:int, h:int):void
  
Parameters


w:int


 


h:int



See also


setSize()





setToolTipText () method  



public function setToolTipText(t:String):void
  Registers the text to display in a tool tip. 
  The text displays when the cursor lingers over the component. 
  

  This tip will display with a shared tool tip with other components, 
  so if you want to display more than one tip at same time, you may 
  need to create your JToolTip or JSharedToolTip.
  
  Parameters


t:String — the string to display; if the text is null, 
  the tool tip is turned off for this component
  



See also


JToolTip


JSharedToolTip





setUI () method  



public function setUI(newUI:ComponentUI):void
     Sets the look and feel delegate for this component.
     Component subclasses generally override this method
     to narrow the argument type. For example, in JSlider:
     
     public void setUI(SliderUI newUI) {
         super.setUI(newUI);
     }
      
     

     Additionally Component subclasses must provide a
     getUI method that returns the correct type.  For example:
     
     public SliderUI getUI() {
         return (SliderUI)ui;
     }
     
          Parameters


newUI:ComponentUI — the new UI delegate
     



See also


updateUI()


UIManager.getLookAndFeel()


UIManager.getUI()





setUIElement () method  



public function setUIElement(b:Boolean):void
     Sets the component is a ui element or not. (if set true, all of its children will be set to true too)
     
Parameters


b:Boolean — true to set this component to be treated as a element, false not.
     



See also


isUIElement()





setVisible () method  



public function setVisible(v:Boolean):void
  Set a component to be hide or shown.
  If a component was hide, some laterly operation may not be done,
  they will be done when next shown, ex: repaint, doLayout ....
  So suggest you dont changed a component's visible frequently.
  
Parameters


v:Boolean






setWidth () method  



public function setWidth(width:int):void
  Sets the component's width.
  
Parameters


width:int — the width of component to set
  



See also


../aswing/Component.html#setSize()





setX () method  



public function setX(x:int):void
  Sets the x coordinate of the components.
  
Parameters


x:int



See also


setLocation()





setY () method  



public function setY(y:int):void
  Sets the y coordinate of the components.
  
Parameters


y:int



See also


setLocation()





size () method  



protected function size():void
  Do the process when size changed.
  



toString () method  



public override function toString():String

Returns


String






transferFocus () method  



public function transferFocus():Boolean
     Transfers the focus to the next component, as though this Component were
     the focus owner.
     
     

Returns


Boolean — true if transfered, false otherwise
     



See also


../aswing/Component.html#requestFocus()





transferFocusBackward () method  



public function transferFocusBackward():Boolean
     Transfers the focus to the previous component, as though this Component
     were the focus owner.
     
     

Returns


Boolean — true if transfered, false otherwise
     



See also


../aswing/Component.html#requestFocus()





updateUI () method  



public function updateUI():void
     Resets the UI property to a value from the current look and feel.
     Component subclasses must override this method
     like this:
     
       public void updateUI() {
          setUI(SliderUI(UIManager.getUI(this)));
       }
      
          

See also


setUI()


org.aswing.UIManager.getLookAndFeel()


org.aswing.UIManager.getUI()





validate () method  



public function validate():void
     Ensures that this component has a valid layout.  This method is
     primarily intended to operate on instances of Container.
     

See also


../aswing/Component.html#invalidate()


../aswing/Component.html#doLayout()


../aswing/LayoutManager.html


../aswing/Container.html#validate()


Event detail



clickCount event 



Event object type: org.aswing.event.ClickCountEvent


ClickCountEvent.type property = org.aswing.event.ClickCountEvent.CLICK_COUNT


  Dispatched when the component is clicked continuesly.
   

      The ClickCountEvent.CLICK_COUNT constant defines the value of the
      type property of the event object for a clickCount event.
           
The properties of the event object have the following values:
      
         Property Value
         bubbles false
         cancelable false
         getCount() the continuesly clicked count
         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.
      
           



dragDrop event   



Event object type: org.aswing.event.DragAndDropEvent


DragAndDropEvent.type property = org.aswing.event.DragAndDropEvent.DRAG_DROP


 Dispatched when a drag is drop on this component.
 

      The DragAndDropEvent.DRAG_DROP constant defines the value of the
      type property of the event object for a dragDrop event.
           
The properties of the event object have the following values:
      
         Property Value
         bubbles false
         cancelable false
         getDragInitiator() the drag initiator component
         getSourceData() the drag source data
         getMousePosition() the mouse point in stage scope
         getTargetComponent() the mouse entered target component
         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.
      
           
See also


isDropTrigger()





dragEnter event   



Event object type: org.aswing.event.DragAndDropEvent


DragAndDropEvent.type property = org.aswing.event.DragAndDropEvent.DRAG_ENTER


 Dispatched when a drag is enter this component area.
 

      The DragAndDropEvent.DRAG_ENTER constant defines the value of the
      type property of the event object for a dragEnter event.
           
The properties of the event object have the following values:
      
         Property Value
         bubbles false
         cancelable false
         getDragInitiator() the drag initiator component
         getSourceData() the drag source data
         getMousePosition() the mouse point in stage scope
         getTargetComponent() the mouse entered target component
         getRelatedTargetComponent() the previouse entered 
       target component
         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.
      
           
See also


isDropTrigger()





dragExit event   



Event object type: org.aswing.event.DragAndDropEvent


DragAndDropEvent.type property = org.aswing.event.DragAndDropEvent.DRAG_EXIT


 Dispatched when a drag is exit this component area.
 

      The DragAndDropEvent.DRAG_EXIT constant defines the value of the
      type property of the event object for a dragExit event.
           
The properties of the event object have the following values:
      
         Property Value
         bubbles false
         cancelable false
         getDragInitiator() the drag initiator component
         getSourceData() the drag source data
         getMousePosition() the mouse point in stage scope
         getTargetComponent() the mouse entered target component
         getRelatedTargetComponent() the next being entered 
       target component
         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.
      
           
See also


isDropTrigger()





dragRecongnized event   



Event object type: org.aswing.event.DragAndDropEvent


DragAndDropEvent.type property = org.aswing.event.DragAndDropEvent.DRAG_RECOGNIZED


 Dispatched when the component is recongnized that it can be drag start.
 

      The DragAndDropEvent.DRAG_RECOGNIZED constant defines the value of the
      type property of the event object for a dragRecongnized event.
           
The properties of the event object have the following values:
      
         Property Value
         bubbles false
         cancelable false
         getDragInitiator() the drag initiator component
         getMousePosition() the mouse point in stage scope
         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.
      
           
See also


isDragEnabled()





focusGained event   



Event object type: org.aswing.event.AWEvent


AWEvent.type property = org.aswing.event.AWEvent.FOCUS_GAINED


 Dispatched when the component gained the focus from it is not the focus owner
 
 

      The AWEvent.FOCUS_GAINED constant defines the value of the
      type property of the event object for a focusGained 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.
      
           



focusKeyDown event   



Event object type: org.aswing.event.FocusKeyEvent


FocusKeyEvent.type property = org.aswing.event.FocusKeyEvent.FOCUS_KEY_DOWN


 Dispatched when the key down and the component is the focus owner.
 
 

      The FocusKeyEvent.FOCUS_KEY_DOWN constant defines the value of the
      type property of the event object for a focusKeyDown event.
           
The properties of the event object have the following values:
      
         Property Value
         bubbles false
         cancelable false
         charCode The character code value of the key pressed or released.
         keyCode The key code value of the key pressed or released.
         keyLocation The location of the key on the keyboard.
         ctrlKey true if the Control key is active; false if it is inactive.
         altKey false, reserved
         shiftKey true if the Shift key is active; false if it is inactive.
         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.
      
           



focusKeyUp event   



Event object type: org.aswing.event.FocusKeyEvent


FocusKeyEvent.type property = org.aswing.event.FocusKeyEvent.FOCUS_KEY_UP


 Dispatched when the key up and the component is the focus owner.
 
 

      The FocusKeyEvent.FOCUS_KEY_UP constant defines the value of the
      type property of the event object for a focusKeyUp event.
           
The properties of the event object have the following values:
      
         Property Value
         bubbles false
         cancelable false
         charCode The character code value of the key pressed or released.
         keyCode The key code value of the key pressed or released.
         keyLocation The location of the key on the keyboard.
         ctrlKey true if the Control key is active; false if it is inactive.
         altKey false, reserved
         shiftKey true if the Shift key is active; false if it is inactive.
         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.
      
           



focusLost event   



Event object type: org.aswing.event.AWEvent


AWEvent.type property = org.aswing.event.AWEvent.FOCUS_LOST


 Dispatched when the component lost the focus from it was the focus owner.
 
 

      The AWEvent.FOCUS_LOST constant defines the value of the
      type property of the event object for a focusLost 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.
      
           



hidden event   



Event object type: org.aswing.event.AWEvent


AWEvent.type property = org.aswing.event.AWEvent.HIDDEN


  Dispatched when the component visible is set to false from true.
   

      The AWEvent.HIDDEN constant defines the value of the
      type property of the event object for a hidden 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.
      
           



moved event   



Event object type: org.aswing.event.MovedEvent


MovedEvent.type property = org.aswing.event.MovedEvent.MOVED


  Dispatched when the component is moved.
   

      The MovedEvent.MOVED constant defines the value of the
      type property of the event object for a moved event.
           
The properties of the event object have the following values:
      
         Property Value
         bubbles false
         cancelable false
         getOldLocation() the old location
         getNewLocation() the new location
         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.
      
           



paint event   



Event object type: org.aswing.event.AWEvent


AWEvent.type property = org.aswing.event.AWEvent.PAINT


  Dispatched when the component is painted.
   

      The AWEvent.PAINT constant defines the value of the
      type property of the event object for a paint 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.
      
           



resized event   



Event object type: org.aswing.event.ResizedEvent


ResizedEvent.type property = org.aswing.event.ResizedEvent.RESIZED


  Dispatched when the component is resized.
   

      The ResizedEvent.RESIZED constant defines the value of the
      type property of the event object for a resized event.
           
The properties of the event object have the following values:
      
         Property Value
         bubbles false
         cancelable false
         getOldSize() the old size
         getNewSize() the new size
         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.
      
           



shown event   



Event object type: org.aswing.event.AWEvent


AWEvent.type property = org.aswing.event.AWEvent.SHOWN


  Dispatched when the component visible is set to true from false.
   

      The AWEvent.SHOWN constant defines the value of the
      type property of the event object for a shown 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.

AsWing A3 API	All Packages \| All Classes \| Index \| Frames No Frames
Class Component	Properties \| Methods \| Events

Package	org.aswing
Class	public class Component
Inheritance	Component AWSprite flash.display.Sprite
Subclasses	AbstractButton, Container, JAdjuster, JComboBox, JLabel, JProgressBar, JScrollBar, JSeparator, JSlider, JSpacer, JTextComponent, PoorTextCell

	`x:int`

	`y:int`

	`w:int`

	`h:int`

Property	Value
`bubbles`	false
`cancelable`	false
`getCount()`	the continuesly clicked count
`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.

Property	Value
`bubbles`	false
`cancelable`	false
`getDragInitiator()`	the drag initiator component
`getSourceData()`	the drag source data
`getMousePosition()`	the mouse point in stage scope
`getTargetComponent()`	the mouse entered target component
`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.

	`key:*` — the new client property key

	`value:*` — the new client property value

	`x:int` — the global x location.

	`y:int` — the global y location.