Click or drag to resize
Window Class
Window class. 窗口使用前首先要设置窗口中需要显示的内容,这通常是在编辑器里制作好的,可以直接使用Window.contentPane进行设置。 建议把设置contentPane等初始化操作放置到Window.onInit方法中。 另外,FairyGUI还提供了一套机制用于窗口动态创建。动态创建是指初始时仅指定窗口需要使用的资源,等窗口需要显示时才实际开始构建窗口的内容。 首先需要在窗口的构造函数中调用Window.addUISource。这个方法需要一个IUISource类型的参数,而IUISource是一个接口, 用户需要自行实现载入相关UI包的逻辑。当窗口第一次显示之前,IUISource的加载方法将会被调用,并等待载入完成后才返回执行Window.OnInit,然后窗口才会显示。 如果你需要窗口显示时播放动画效果,那么覆盖doShowAnimation编写你的动画代码,并且在动画结束后调用onShown。覆盖onShown编写其他需要在窗口显示时处理的业务逻辑。 如果你需要窗口隐藏时播放动画效果,那么覆盖doHideAnimation编写你的动画代码,并且在动画结束时调用Window.hideImmediately(注意不是直接调用onHide!)。覆盖onHide编写其他需要在窗口隐藏时处理的业务逻辑。
Inheritance Hierarchy
SystemObject
  FairyGUIEventDispatcher
    FairyGUIGObject
      FairyGUIGComponent
        FairyGUIWindow

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

The Window type exposes the following members.

Constructors
  NameDescription
Public methodWindow
Initializes a new instance of the Window class
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 methodAddUISource
Set a UISource to this window. It must call before the window is shown. When the window is first time to show, UISource.Load is called. Only after all UISource is loaded, the window will continue to init. 为窗口添加一个源。这个方法建议在构造函数调用。当窗口第一次显示前,UISource的Load方法将被调用,然后只有所有的UISource 都ready后,窗口才会继续初始化和显示。
Public methodBringToFront
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 methodCenterOn
Make the window be center of the screen.
Public methodCloseModalWait
Public methodCloseModalWait(Int32)
Close modal waiting. If rquestingCmd is equal to the value you transfer in ShowModalWait, mowal wait will be closed. Otherwise, this function has no effect. 关闭模式等待。如果requestingCmd和ShowModalWait传入的不相同,则这个函数没有任何动作,立即返回。
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
Releases all resources used by the Window
(Overrides GComponentDispose.)
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 methodGetChild
Returns a child object with a certain name.
(Inherited from GComponent.)
Public methodGetChildAt
Returns a child object at a certain index. If index out of bounds, exception raised.
(Inherited from GComponent.)
Public methodGetChildIndex
Returns the index of a child within the container, or "-1" if it is not found.
(Inherited from GComponent.)
Public methodGetChildInGroup
Returns a child object belong to a group with a certain name.
(Inherited from GComponent.)
Public methodGetChildren
Returns a copy of all children with an array.
(Inherited from GComponent.)
Public methodGetController
Returns a controller object with a certain name.
(Inherited from GComponent.)
Public methodGetControllerAt
Returns a controller object at a certain index.
(Inherited from GComponent.)
Public methodGetFirstChildInView (Inherited from GComponent.)
Public methodGetGear (Inherited from GObject.)
Public methodGetTransition
Returns a transition object at a certain name.
(Inherited from GComponent.)
Public methodGetTransitionAt
Returns a transition object at a certain index.
(Inherited from GComponent.)
Public methodGetVisibleChild
Returns a visible child object with a certain name.
(Inherited from GComponent.)
Public methodGlobalToLocal(Rect)
(Inherited from GObject.)
Public methodGlobalToLocal(Vector2)
Transforms a point from global (Stage) coordinates to the local coordinate system.
(Inherited from GObject.)
Public methodHandleControllerChanged (Inherited from GObject.)
Public methodHide
Public methodHideImmediately
Hide window immediately, no OnHide will be called.
Public methodInit
Public methodInvalidateBatchingState
Mark the fairy batching state is invalid.
(Inherited from GObject.)
Public methodInvalidateBatchingState(Boolean) (Inherited from GComponent.)
Public methodIsAncestorOf
(Inherited from GComponent.)
Public methodIsChildInView
Test if a child is in view.
(Inherited from GComponent.)
Public methodLocalToGlobal(Rect)
(Inherited from GObject.)
Public methodLocalToGlobal(Vector2)
Transforms a point from the local coordinate system to global (Stage) coordinates.
(Inherited from GObject.)
Public methodLocalToRoot
Transforms a point from the local coordinate system to GRoot coordinates.
(Inherited from GObject.)
Public methodRemoveChild(GObject)
Removes a child from the component. If the object is not a child, nothing happens.
(Inherited from GComponent.)
Public methodRemoveChild(GObject, Boolean)
Removes a child from the component. If the object is not a child, nothing happens.
(Inherited from GComponent.)
Public methodRemoveChildAt(Int32)
Removes a child at a certain index. Children above the child will move down.
(Inherited from GComponent.)
Public methodRemoveChildAt(Int32, Boolean)
Removes a child at a certain index. Children above the child will move down.
(Inherited from GComponent.)
Public methodRemoveChildren
Remove all children.
(Inherited from GComponent.)
Public methodRemoveChildren(Int32, Int32, Boolean)
Removes a range of children from the container (endIndex included).
(Inherited from GComponent.)
Public methodRemoveController
Removes a controller from the container.
(Inherited from GComponent.)
Public methodRemoveEventListener(String, EventCallback0)
(Inherited from EventDispatcher.)
Public methodRemoveEventListener(String, EventCallback1)
(Inherited from EventDispatcher.)
Public methodRemoveEventListeners
(Inherited from EventDispatcher.)
Public methodRemoveEventListeners(String)
(Inherited from EventDispatcher.)
Public methodRemoveFromParent
(Inherited from GObject.)
Public methodRemoveRelation
(Inherited from GObject.)
Public methodRequestFocus
Request focus on this object.
(Inherited from GObject.)
Public methodRootToLocal
Transforms a point from the GRoot coordinate to local coordinates system.
(Inherited from GObject.)
Public methodSetBoundsChangedFlag
Notify the component the bounds should recaculate.
(Inherited from GComponent.)
Public methodSetChildIndex
Moves a child to a certain index. Children at and after the replaced position move up.
(Inherited from GComponent.)
Public methodSetChildIndexBefore
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的对象的前面。
(Inherited from GComponent.)
Public methodSetPivot(Single, Single)
Change the x and y coordinates of the object's origin in its own coordinate space.
(Inherited from GObject.)
Public methodSetPivot(Single, Single, Boolean)
Change the x and y coordinates of the object's origin in its own coordinate space.
(Inherited from GObject.)
Public methodSetPosition
change the x,y,z coordinates of the object relative to the local coordinates of the parent.
(Inherited from GObject.)
Public methodSetScale
Change the scale factor.
(Inherited from GObject.)
Public methodSetSize(Single, Single)
Change size.
(Inherited from GObject.)
Public methodSetSize(Single, Single, Boolean)
Change size.
(Inherited from GObject.)
Public methodSetup_AfterAdd (Inherited from GObject.)
Public methodSetup_BeforeAdd (Inherited from GObject.)
Public methodSetXY
change the x and y coordinates of the object relative to the local coordinates of the parent.
(Inherited from GObject.)
Public methodShow
Public methodShowModalWait
Public methodShowModalWait(Int32)
Display a modal waiting sign in the front. 显示一个等待标志在最前面。等待标志的资源可以通过UIConfig.windowModalWaiting。等待标志组件会设置为屏幕大小,请内部做好关联。 还可以设定一个requestingCmd作为等待的命令字,在CloseModalWait里传入相同的命令字ModalWait将结束,否则CloseModalWait无效。
Public methodShowOn
Public methodStartDrag
(Inherited from GObject.)
Public methodStartDrag(Int32)
(Inherited from GObject.)
Public methodStopDrag
(Inherited from GObject.)
Public methodSwapChildren
Swaps the indexes of two children.
(Inherited from GComponent.)
Public methodSwapChildrenAt
Swaps the indexes of two children.
(Inherited from GComponent.)
Public methodToggleStatus
Switch show and hide status.
Public methodTransformPoint
(Inherited from GObject.)
Public methodTransformRect
(Inherited from GObject.)
Public methodTweenFade (Inherited from GObject.)
Public methodTweenMove (Inherited from GObject.)
Public methodTweenMoveX (Inherited from GObject.)
Public methodTweenMoveY (Inherited from GObject.)
Public methodTweenResize (Inherited from GObject.)
Public methodTweenRotate (Inherited from GObject.)
Public methodTweenScale (Inherited from GObject.)
Public methodTweenScaleX (Inherited from GObject.)
Public methodTweenScaleY (Inherited from GObject.)
Public methodWorldToLocal(Vector3)
(Inherited from GObject.)
Public methodWorldToLocal(Vector3, Camera)
(Inherited from GObject.)
Top
Fields
  NameDescription
Public fielddata
User defined data.
(Inherited from GObject.)
Public fielddragBounds
Restricted range of dragging.
(Inherited from GObject.)
Public fieldgroup
Group belonging to.
(Inherited from GObject.)
Public fieldname
Name of the object.
(Inherited from GObject.)
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 propertyblendMode (Inherited from GObject.)
Public propertybringToFontOnClick
Public propertychildrenRenderOrder (Inherited from GComponent.)
Public propertyclipSoftness
If clipping softness is set, clipped containers will have soft border effect.
(Inherited from GComponent.)
Public propertycloseButton
Public propertycontainer
Content container. If the component is not clipped, then container==rootContainer.
(Inherited from GComponent.)
Public propertycontentArea
Public propertycontentPane
Public propertyControllers
Returns controller list.
(Inherited from GComponent.)
Public propertydisplayObject
Lowlevel display object.
(Inherited from GObject.)
Public propertydragArea
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 propertyframe
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 propertyheight
The height of the object in pixels.
(Inherited from GObject.)
Public propertyicon
(Inherited from GObject.)
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 propertyinitHeight
The initial height of the object.
(Inherited from GObject.)
Public propertyinitWidth
The initial width of the object.
(Inherited from GObject.)
Public propertyisShowing
Public propertyisTop
Public propertymargin (Inherited from GComponent.)
Public propertymask
The mask of the component.
(Inherited from GComponent.)
Public propertymodal
Public propertymodalWaiting
Public propertymodalWaitingPane
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 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
Only available for mouse input: the cursor leave an object.
(Inherited from GObject.)
Public propertyonRollOver
Only available for mouse input: the cursor 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 propertyopaque
If true, mouse/touch events cannot pass through the empty area of the component. Default is true.
(Inherited from GComponent.)
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 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 propertyrelations
Relations Object.
(Inherited from GObject.)
Public propertyresourceURL
Resource url of this object.
(Inherited from GObject.)
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 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 propertysourceHeight
The source height of the object.
(Inherited from GObject.)
Public propertysourceWidth
The source width of the object.
(Inherited from GObject.)
Public propertytext
(Inherited from GObject.)
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 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 propertyz
The z coordinate of the object relative to the local coordinates of the parent.
(Inherited from GObject.)
Top
See Also