GComponent Class |
Namespace: FairyGUI
public class GComponent : GObject
The GComponent type exposes the following members.
| Name | Description | |
|---|---|---|
| GComponent | Initializes a new instance of the GComponent class |
| Name | Description | |
|---|---|---|
| actualHeight |
actualHeight = height * scaleY
(Inherited from GObject.) | |
| actualWidth |
actualWidth = width * scalex
(Inherited from GObject.) | |
| alpha |
The opacity of the object. 0 = transparent, 1 = opaque.
(Inherited from GObject.) | |
| apexIndex | ||
| asButton | (Inherited from GObject.) | |
| asCom | (Inherited from GObject.) | |
| asComboBox | (Inherited from GObject.) | |
| asGraph | (Inherited from GObject.) | |
| asGroup | (Inherited from GObject.) | |
| asImage | (Inherited from GObject.) | |
| asLabel | (Inherited from GObject.) | |
| asList | (Inherited from GObject.) | |
| asLoader | (Inherited from GObject.) | |
| asMovieClip | (Inherited from GObject.) | |
| asProgress | (Inherited from GObject.) | |
| asRichTextField | (Inherited from GObject.) | |
| asSlider | (Inherited from GObject.) | |
| asTextField | (Inherited from GObject.) | |
| asTextInput | (Inherited from GObject.) | |
| baseUserData | ||
| blendMode | (Inherited from GObject.) | |
| childrenRenderOrder | ||
| clipSoftness |
If clipping softness is set, clipped containers will have soft border effect.
| |
| container |
Content container. If the component is not clipped, then container==rootContainer.
| |
| Controllers |
Returns controller list.
| |
| displayObject |
Lowlevel display object.
(Inherited from GObject.) | |
| draggable | (Inherited from GObject.) | |
| dragging | (Inherited from GObject.) | |
| enabled |
Enabled is shortcut for grayed and !touchable combination.
(Inherited from GObject.) | |
| fairyBatching |
Draw call optimization switch.
| |
| filter | (Inherited from GObject.) | |
| focusable |
If the object can be focused?
(Inherited from GObject.) | |
| focused |
If the object is focused. Focused object can receive key events.
(Inherited from GObject.) | |
| gameObjectName |
设定GameObject的名称
(Inherited from GObject.) | |
| gearLook |
Gear to look controller.
(Inherited from GObject.) | |
| gearSize |
Gear to size controller.
(Inherited from GObject.) | |
| gearXY |
Gear to xy controller.
(Inherited from GObject.) | |
| grayed |
If true, apply a grayed effect on this object.
(Inherited from GObject.) | |
| group |
Group belonging to.
(Inherited from GObject.) | |
| height |
The height of the object in pixels.
(Inherited from GObject.) | |
| icon | (Inherited from GObject.) | |
| id |
GObject的id,仅作为内部使用。与name不同,id值是不会相同的。
id is for internal use only.
(Inherited from GObject.) | |
| inContainer |
If the object has lowlevel displayobject and the displayobject has a container parent?
(Inherited from GObject.) | |
| margin | ||
| mask |
The mask of the component.
| |
| numChildren |
The number of children of this component.
| |
| onAddedToStage |
Dispatched when the object was added to the stage.
(Inherited from GObject.) | |
| onClick |
Dispatched when the object or its child was clicked.
(Inherited from GObject.) | |
| onClickLink |
Dispatched when links in the object or its child was clicked.
(Inherited from GObject.) | |
| onDragEnd |
Dispatched when drag end.
(Inherited from GObject.) | |
| onDragMove |
Dispatched when dragging.
(Inherited from GObject.) | |
| onDragStart |
Dispatched when drag start.
(Inherited from GObject.) | |
| onDrop |
Dispatched when an object was dragged and dropped to this component.
| |
| OnGearStop | (Inherited from GObject.) | |
| onKeyDown |
Dispatched on key pressed when the object is in focus.
(Inherited from GObject.) | |
| onPositionChanged |
Dispatched when the object was moved.
(Inherited from GObject.) | |
| onRemovedFromStage |
Dispatched when the object was removed from the stage.
(Inherited from GObject.) | |
| onRightClick |
Dispatched when the object or its child was clicked by right mouse button. Web only.
(Inherited from GObject.) | |
| onRollOut |
The cursor or finger leave an object.
(Inherited from GObject.) | |
| onRollOver |
The cursor or finger hovers over an object.
(Inherited from GObject.) | |
| onSizeChanged |
Dispatched when the object was resized.
(Inherited from GObject.) | |
| onStage |
If the object is on stage.
(Inherited from GObject.) | |
| onTouchBegin |
Dispatched when the finger touched the object or its child just now.
(Inherited from GObject.) | |
| onTouchEnd |
Dispatched when the finger was lifted from the screen or from the mouse button.
(Inherited from GObject.) | |
| onTouchMove | (Inherited from GObject.) | |
| opaque |
If true, mouse/touch events cannot pass through the empty area of the component. Default is true.
| |
| parent |
Parent object.
(Inherited from GObject.) | |
| pivot |
The x and y coordinates of the object's origin in its own coordinate space.
(Inherited from GObject.) | |
| pivotAsAnchor | (Inherited from GObject.) | |
| pivotX |
The x coordinate of the object's origin in its own coordinate space.
(Inherited from GObject.) | |
| pivotY |
The y coordinate of the object's origin in its own coordinate space.
(Inherited from GObject.) | |
| pixelSnapping | (Inherited from GObject.) | |
| position |
The x,y,z coordinates of the object relative to the local coordinates of the parent.
(Inherited from GObject.) | |
| relations |
Relations Object.
(Inherited from GObject.) | |
| resourceURL |
Resource url of this object.
(Inherited from GObject.) | |
| reversedMask | ||
| root | (Inherited from GObject.) | |
| rootContainer |
Root container.
| |
| rotation |
The rotation around the z axis of the object in degrees.
(Inherited from GObject.) | |
| rotationX |
The rotation around the x axis of the object in degrees.
(Inherited from GObject.) | |
| rotationY |
The rotation around the y axis of the object in degrees.
(Inherited from GObject.) | |
| scale |
The scale factor.
(Inherited from GObject.) | |
| scaleX |
The horizontal scale factor. '1' means no scale, cannt be negative.
(Inherited from GObject.) | |
| scaleY |
The vertical scale factor. '1' means no scale, cannt be negative.
(Inherited from GObject.) | |
| scrollPane |
ScrollPane of the component. If the component is not scrollable, the value is null.
| |
| size |
The size of the object in pixels.
(Inherited from GObject.) | |
| skew | (Inherited from GObject.) | |
| sortingOrder |
By default(when sortingOrder==0), object added to component is arrange by the added roder.
The bigger is the sorting order, the object is more in front.
(Inherited from GObject.) | |
| text | (Inherited from GObject.) | |
| tooltips |
Tooltips of this object. UIConfig.tooltipsWin must be set first.
(Inherited from GObject.) | |
| touchable |
If the object can touch or click. GImage/GTextField is not touchable even it is true.
(Inherited from GObject.) | |
| viewHeight |
View port height of the container.
| |
| viewWidth |
Viwe port width of the container.
| |
| visible |
The visibility of the object. An invisible object will be untouchable.
(Inherited from GObject.) | |
| width |
The width of the object in pixels.
(Inherited from GObject.) | |
| x |
The x coordinate of the object relative to the local coordinates of the parent.
(Inherited from GObject.) | |
| xMin | (Inherited from GObject.) | |
| xy |
The x and y coordinates of the object relative to the local coordinates of the parent.
(Inherited from GObject.) | |
| y |
The y coordinate of the object relative to the local coordinates of the parent.
(Inherited from GObject.) | |
| yMin | (Inherited from GObject.) | |
| z |
The z coordinate of the object relative to the local coordinates of the parent.
(Inherited from GObject.) |
| Name | Description | |
|---|---|---|
| AddChild |
Add a child to the component. It will be at the frontmost position.
| |
| AddChildAt |
Adds a child to the component at a certain index.
| |
| AddController |
Adds a controller to the container.
| |
| AddEventListener(String, EventCallback0) | (Inherited from EventDispatcher.) | |
| AddEventListener(String, EventCallback1) | (Inherited from EventDispatcher.) | |
| AddRelation(GObject, RelationType) | (Inherited from GObject.) | |
| AddRelation(GObject, RelationType, Boolean) | (Inherited from GObject.) | |
| BroadcastEvent | (Inherited from EventDispatcher.) | |
| BubbleEvent | (Inherited from EventDispatcher.) | |
| Center |
Set the object in middle of the parent or GRoot if the parent is not set.
(Inherited from GObject.) | |
| Center(Boolean) |
Set the object in middle of the parent or GRoot if the parent is not set.
(Inherited from GObject.) | |
| ConstructFromResource | (Overrides GObjectConstructFromResource.) | |
| ConstructFromXML |
Method for extensions to override
| |
| DispatchEvent(String) | (Inherited from EventDispatcher.) | |
| DispatchEvent(EventContext) | (Inherited from EventDispatcher.) | |
| DispatchEvent(String, Object) | (Inherited from EventDispatcher.) | |
| DispatchEvent(String, Object, Object) | (Inherited from EventDispatcher.) | |
| Dispose | Releases all resources used by the GComponent (Overrides GObjectDispose.) | |
| EnsureBoundsCorrect |
Make sure the bounds of the component is correct.
Bounds of the component is not updated on every changed. For example, you add a new child to the list, children in the list will be rearranged in next frame.
If you want to access the correct child position immediatelly, call this function first.
| |
| GetChild |
Returns a child object with a certain name.
| |
| GetChildAt |
Returns a child object at a certain index. If index out of bounds, exception raised.
| |
| GetChildIndex |
Returns the index of a child within the container, or "-1" if it is not found.
| |
| GetChildInGroup |
Returns a child object belong to a group with a certain name.
| |
| GetChildren |
Returns a copy of all children with an array.
| |
| GetController |
Returns a controller object with a certain name.
| |
| GetControllerAt |
Returns a controller object at a certain index.
| |
| GetFirstChildInView | ||
| GetGear | (Inherited from GObject.) | |
| GetTransition |
Returns a transition object at a certain name.
| |
| GetTransitionAt |
Returns a transition object at a certain index.
| |
| GetVisibleChild |
Returns a visible child object with a certain name.
| |
| GlobalToLocal(Rect) | (Inherited from GObject.) | |
| GlobalToLocal(Vector2) |
Transforms a point from global (Stage) coordinates to the local coordinate system.
(Inherited from GObject.) | |
| HandleControllerChanged | (Overrides GObjectHandleControllerChanged(Controller).) | |
| InvalidateBatchingState |
Mark the fairy batching state is invalid.
(Inherited from GObject.) | |
| InvalidateBatchingState(Boolean) | ||
| IsAncestorOf | ||
| IsChildInView |
Test if a child is in view.
| |
| LocalToGlobal(Rect) | (Inherited from GObject.) | |
| LocalToGlobal(Vector2) |
Transforms a point from the local coordinate system to global (Stage) coordinates.
(Inherited from GObject.) | |
| LocalToRoot |
Transforms a point from the local coordinate system to GRoot coordinates.
(Inherited from GObject.) | |
| MakeFullScreen |
设置对象为全屏大小(逻辑屏幕)。
(Inherited from GObject.) | |
| RemoveChild(GObject) |
Removes a child from the component. If the object is not a child, nothing happens.
| |
| RemoveChild(GObject, Boolean) |
Removes a child from the component. If the object is not a child, nothing happens.
| |
| RemoveChildAt(Int32) |
Removes a child at a certain index. Children above the child will move down.
| |
| RemoveChildAt(Int32, Boolean) |
Removes a child at a certain index. Children above the child will move down.
| |
| RemoveChildren |
Remove all children.
| |
| RemoveChildren(Int32, Int32, Boolean) |
Removes a range of children from the container (endIndex included).
| |
| RemoveController |
Removes a controller from the container.
| |
| RemoveEventListener(String, EventCallback0) | (Inherited from EventDispatcher.) | |
| RemoveEventListener(String, EventCallback1) | (Inherited from EventDispatcher.) | |
| RemoveEventListeners | (Inherited from EventDispatcher.) | |
| RemoveEventListeners(String) | (Inherited from EventDispatcher.) | |
| RemoveFromParent | (Inherited from GObject.) | |
| RemoveRelation | (Inherited from GObject.) | |
| RequestFocus |
Request focus on this object.
(Inherited from GObject.) | |
| RootToLocal |
Transforms a point from the GRoot coordinate to local coordinates system.
(Inherited from GObject.) | |
| SetBoundsChangedFlag |
Notify the component the bounds should recaculate.
| |
| SetChildIndex |
Moves a child to a certain index. Children at and after the replaced position move up.
| |
| SetChildIndexBefore |
Moves a child to a certain position which is in front of the child previously at given index.
与SetChildIndex不同的是,如果child原来在index的前面,那么child插入的位置是index-1,即保证排在原来占据index的对象的前面。
| |
| SetHome | (Inherited from GObject.) | |
| SetPivot(Single, Single) |
Change the x and y coordinates of the object's origin in its own coordinate space.
(Inherited from GObject.) | |
| SetPivot(Single, Single, Boolean) |
Change the x and y coordinates of the object's origin in its own coordinate space.
(Inherited from GObject.) | |
| SetPosition |
change the x,y,z coordinates of the object relative to the local coordinates of the parent.
(Inherited from GObject.) | |
| SetScale |
Change the scale factor.
(Inherited from GObject.) | |
| SetSize(Single, Single) |
Change size.
(Inherited from GObject.) | |
| SetSize(Single, Single, Boolean) |
Change size.
(Inherited from GObject.) | |
| Setup_AfterAdd | (Overrides GObjectSetup_AfterAdd(ByteBuffer, Int32).) | |
| Setup_BeforeAdd | (Inherited from GObject.) | |
| SetXY(Single, Single) |
change the x and y coordinates of the object relative to the local coordinates of the parent.
(Inherited from GObject.) | |
| SetXY(Single, Single, Boolean) | (Inherited from GObject.) | |
| StartDrag | (Inherited from GObject.) | |
| StartDrag(Int32) | (Inherited from GObject.) | |
| StopDrag | (Inherited from GObject.) | |
| SwapChildren |
Swaps the indexes of two children.
| |
| SwapChildrenAt |
Swaps the indexes of two children.
| |
| TransformPoint | (Inherited from GObject.) | |
| TransformRect | (Inherited from GObject.) | |
| TweenFade | (Inherited from GObject.) | |
| TweenMove | (Inherited from GObject.) | |
| TweenMoveX | (Inherited from GObject.) | |
| TweenMoveY | (Inherited from GObject.) | |
| TweenResize | (Inherited from GObject.) | |
| TweenRotate | (Inherited from GObject.) | |
| TweenScale | (Inherited from GObject.) | |
| TweenScaleX | (Inherited from GObject.) | |
| TweenScaleY | (Inherited from GObject.) | |
| WorldToLocal(Vector3) | (Inherited from GObject.) | |
| WorldToLocal(Vector3, Camera) | (Inherited from GObject.) |
| Name | Description | |
|---|---|---|
| data |
User defined data.
(Inherited from GObject.) | |
| dragBounds |
Restricted range of dragging.
(Inherited from GObject.) | |
| initHeight |
The initial height of the object.
(Inherited from GObject.) | |
| initWidth |
The initial width of the object.
(Inherited from GObject.) | |
| maxHeight | (Inherited from GObject.) | |
| maxWidth | (Inherited from GObject.) | |
| minHeight | (Inherited from GObject.) | |
| minWidth | (Inherited from GObject.) | |
| name |
Name of the object.
(Inherited from GObject.) | |
| packageItem | (Inherited from GObject.) | |
| sourceHeight |
The source height of the object.
(Inherited from GObject.) | |
| sourceWidth |
The source width of the object.
(Inherited from GObject.) |