Click or drag to resize

GButton Class

GButton class.
Inheritance Hierarchy
SystemObject
  FairyGUIEventDispatcher
    FairyGUIGObject
      FairyGUIGComponent
        FairyGUIGButton

Namespace:  FairyGUI
Assembly:  FairyGUI (in FairyGUI.dll) Version: 1.0.0.0 (1.0.0.0)
Syntax
C#
public class GButton : GComponent, IColorGear

The GButton type exposes the following members.

Constructors
  NameDescription
Public methodGButton
Initializes a new instance of the GButton class
Top
Properties
  NameDescription
Public propertyactualHeight
actualHeight = height * scaleY
(Inherited from GObject.)
Public propertyactualWidth
actualWidth = width * scalex
(Inherited from GObject.)
Public propertyalpha
The opacity of the object. 0 = transparent, 1 = opaque.
(Inherited from GObject.)
Public propertyapexIndex (Inherited from GComponent.)
Public propertyasButton (Inherited from GObject.)
Public propertyasCom (Inherited from GObject.)
Public propertyasComboBox (Inherited from GObject.)
Public propertyasGraph (Inherited from GObject.)
Public propertyasGroup (Inherited from GObject.)
Public propertyasImage (Inherited from GObject.)
Public propertyasLabel (Inherited from GObject.)
Public propertyasList (Inherited from GObject.)
Public propertyasLoader (Inherited from GObject.)
Public propertyasMovieClip (Inherited from GObject.)
Public propertyasProgress (Inherited from GObject.)
Public propertyasRichTextField (Inherited from GObject.)
Public propertyasSlider (Inherited from GObject.)
Public propertyasTextField (Inherited from GObject.)
Public propertyasTextInput (Inherited from GObject.)
Public propertybaseUserData
(Inherited from GComponent.)
Public propertyblendMode
(Inherited from GObject.)
Public propertychildrenRenderOrder (Inherited from GComponent.)
Public propertyclipSoftness
If clipping softness is set, clipped containers will have soft border effect.
(Inherited from GComponent.)
Public propertycolor
Public propertycontainer
Content container. If the component is not clipped, then container==rootContainer.
(Inherited from GComponent.)
Public propertyControllers
Returns controller list.
(Inherited from GComponent.)
Public propertydisplayObject
Lowlevel display object.
(Inherited from GObject.)
Public propertydraggable
(Inherited from GObject.)
Public propertydragging
(Inherited from GObject.)
Public propertyenabled
Enabled is shortcut for grayed and !touchable combination.
(Inherited from GObject.)
Public propertyfairyBatching
Draw call optimization switch.
(Inherited from GComponent.)
Public propertyfilter
(Inherited from GObject.)
Public propertyfocusable
If the object can be focused?
(Inherited from GObject.)
Public propertyfocused
If the object is focused. Focused object can receive key events.
(Inherited from GObject.)
Public propertygameObjectName
设定GameObject的名称
(Inherited from GObject.)
Public propertygearLook
Gear to look controller.
(Inherited from GObject.)
Public propertygearSize
Gear to size controller.
(Inherited from GObject.)
Public propertygearXY
Gear to xy controller.
(Inherited from GObject.)
Public propertygrayed
If true, apply a grayed effect on this object.
(Inherited from GObject.)
Public propertygroup
Group belonging to.
(Inherited from GObject.)
Public propertyheight
The height of the object in pixels.
(Inherited from GObject.)
Public propertyicon
Icon of the button.
(Overrides GObjecticon.)
Public propertyid
GObject的id,仅作为内部使用。与name不同,id值是不会相同的。 id is for internal use only.
(Inherited from GObject.)
Public propertyinContainer
If the object has lowlevel displayobject and the displayobject has a container parent?
(Inherited from GObject.)
Public propertymargin (Inherited from GComponent.)
Public propertymask
The mask of the component.
(Inherited from GComponent.)
Public propertymode
Button mode.
Public propertynumChildren
The number of children of this component.
(Inherited from GComponent.)
Public propertyonAddedToStage
Dispatched when the object was added to the stage.
(Inherited from GObject.)
Public propertyonChanged
Dispatched when the button status was changed. 如果为单选或多选按钮,当按钮的选中状态发生改变时,此事件触发。
Public propertyonClick
Dispatched when the object or its child was clicked.
(Inherited from GObject.)
Public propertyonClickLink
Dispatched when links in the object or its child was clicked.
(Inherited from GObject.)
Public propertyonDragEnd
Dispatched when drag end.
(Inherited from GObject.)
Public propertyonDragMove
Dispatched when dragging.
(Inherited from GObject.)
Public propertyonDragStart
Dispatched when drag start.
(Inherited from GObject.)
Public propertyonDrop
Dispatched when an object was dragged and dropped to this component.
(Inherited from GComponent.)
Public propertyOnGearStop
(Inherited from GObject.)
Public propertyonKeyDown
Dispatched on key pressed when the object is in focus.
(Inherited from GObject.)
Public propertyonPositionChanged
Dispatched when the object was moved.
(Inherited from GObject.)
Public propertyonRemovedFromStage
Dispatched when the object was removed from the stage.
(Inherited from GObject.)
Public propertyonRightClick
Dispatched when the object or its child was clicked by right mouse button. Web only.
(Inherited from GObject.)
Public propertyonRollOut
The cursor or finger leave an object.
(Inherited from GObject.)
Public propertyonRollOver
The cursor or finger hovers over an object.
(Inherited from GObject.)
Public propertyonSizeChanged
Dispatched when the object was resized.
(Inherited from GObject.)
Public propertyonStage
If the object is on stage.
(Inherited from GObject.)
Public propertyonTouchBegin
Dispatched when the finger touched the object or its child just now.
(Inherited from GObject.)
Public propertyonTouchEnd
Dispatched when the finger was lifted from the screen or from the mouse button.
(Inherited from GObject.)
Public propertyonTouchMove
(Inherited from GObject.)
Public propertyopaque
If true, mouse/touch events cannot pass through the empty area of the component. Default is true.
(Inherited from GComponent.)
Public propertypageOption
The button will be in down status in these pages.
Public propertyparent
Parent object.
(Inherited from GObject.)
Public propertypivot
The x and y coordinates of the object's origin in its own coordinate space.
(Inherited from GObject.)
Public propertypivotAsAnchor (Inherited from GObject.)
Public propertypivotX
The x coordinate of the object's origin in its own coordinate space.
(Inherited from GObject.)
Public propertypivotY
The y coordinate of the object's origin in its own coordinate space.
(Inherited from GObject.)
Public propertypixelSnapping (Inherited from GObject.)
Public propertyposition
The x,y,z coordinates of the object relative to the local coordinates of the parent.
(Inherited from GObject.)
Public propertyrelatedController
A controller is connected to this button, the activate page of this controller will change while the button status changed. 对应编辑器中的单选控制器。
Public propertyrelations
Relations Object.
(Inherited from GObject.)
Public propertyresourceURL
Resource url of this object.
(Inherited from GObject.)
Public propertyreversedMask
(Inherited from GComponent.)
Public propertyroot
(Inherited from GObject.)
Public propertyrootContainer
Root container.
(Inherited from GComponent.)
Public propertyrotation
The rotation around the z axis of the object in degrees.
(Inherited from GObject.)
Public propertyrotationX
The rotation around the x axis of the object in degrees.
(Inherited from GObject.)
Public propertyrotationY
The rotation around the y axis of the object in degrees.
(Inherited from GObject.)
Public propertyscale
The scale factor.
(Inherited from GObject.)
Public propertyscaleX
The horizontal scale factor. '1' means no scale, cannt be negative.
(Inherited from GObject.)
Public propertyscaleY
The vertical scale factor. '1' means no scale, cannt be negative.
(Inherited from GObject.)
Public propertyscrollPane
ScrollPane of the component. If the component is not scrollable, the value is null.
(Inherited from GComponent.)
Public propertyselected
If the button is in selected status.
Public propertyselectedIcon
Icon value on selected status.
Public propertyselectedTitle
Title value on selected status.
Public propertysize
The size of the object in pixels.
(Inherited from GObject.)
Public propertyskew
(Inherited from GObject.)
Public propertysortingOrder
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.)
Public propertytext
Same of the title.
(Overrides GObjecttext.)
Public propertytitle
Title of the button
Public propertytitleColor
Title color.
Public propertytitleFontSize
Public propertytooltips
Tooltips of this object. UIConfig.tooltipsWin must be set first.
(Inherited from GObject.)
Public propertytouchable
If the object can touch or click. GImage/GTextField is not touchable even it is true.
(Inherited from GObject.)
Public propertyviewHeight
View port height of the container.
(Inherited from GComponent.)
Public propertyviewWidth
Viwe port width of the container.
(Inherited from GComponent.)
Public propertyvisible
The visibility of the object. An invisible object will be untouchable.
(Inherited from GObject.)
Public propertywidth
The width of the object in pixels.
(Inherited from GObject.)
Public propertyx
The x coordinate of the object relative to the local coordinates of the parent.
(Inherited from GObject.)
Public propertyxMin
(Inherited from GObject.)
Public propertyxy
The x and y coordinates of the object relative to the local coordinates of the parent.
(Inherited from GObject.)
Public propertyy
The y coordinate of the object relative to the local coordinates of the parent.
(Inherited from GObject.)
Public propertyyMin
(Inherited from GObject.)
Public propertyz
The z coordinate of the object relative to the local coordinates of the parent.
(Inherited from GObject.)
Top
Methods
  NameDescription
Public methodAddChild
Add a child to the component. It will be at the frontmost position.
(Inherited from GComponent.)
Public methodAddChildAt
Adds a child to the component at a certain index.
(Inherited from GComponent.)
Public methodAddController
Adds a controller to the container.
(Inherited from GComponent.)
Public methodAddEventListener(String, EventCallback0)
(Inherited from EventDispatcher.)
Public methodAddEventListener(String, EventCallback1)
(Inherited from EventDispatcher.)
Public methodAddRelation(GObject, RelationType)
(Inherited from GObject.)
Public methodAddRelation(GObject, RelationType, Boolean)
(Inherited from GObject.)
Public methodBroadcastEvent
(Inherited from EventDispatcher.)
Public methodBubbleEvent
(Inherited from EventDispatcher.)
Public methodCenter
Set the object in middle of the parent or GRoot if the parent is not set.
(Inherited from GObject.)
Public methodCenter(Boolean)
Set the object in middle of the parent or GRoot if the parent is not set.
(Inherited from GObject.)
Public methodConstructFromResource (Inherited from GComponent.)
Public methodConstructFromXML
Method for extensions to override
(Inherited from GComponent.)
Public methodDispatchEvent(String)
(Inherited from EventDispatcher.)
Public methodDispatchEvent(EventContext)
(Inherited from EventDispatcher.)
Public methodDispatchEvent(String, Object)
(Inherited from EventDispatcher.)
Public methodDispatchEvent(String, Object, Object) (Inherited from EventDispatcher.)
Public methodDispose (Inherited from GComponent.)
Public methodEnsureBoundsCorrect
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.
(Inherited from GComponent.)
Public method