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

Public Methods

	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

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