OpenFairyGUI API
    Preparing search index...

    Class Component

    A component definition — the primary building block in FairyGUI.

    Components are resource definitions containing a display list (children), controllers (state machines), and transitions (animations). They can be instantiated in other components via GComponent.

    Hierarchy (View Summary)

    Index
    propertyType
    addChild addController addEventListener addRelation addTransition clone copy detach dispatchEvent dispose equals getAddedToStageSound getBgColor getBgColorEnabled getBranch getBranchItemIds getButtonMode getChangeOnClick getChild getChildById getChildrenRenderOrder getClipSoftness getController getCustomData getCustomProperties getDesignImageAlpha getDesignImageLayer getDesignImageOffsetX getDesignImageOffsetY getDownEffect getDownEffectValue getDropdown getExported getExtension getExtensionType getExtras getExtType getFavorite getFixedGripSize getFooterRes getHeaderRes getHeight getHitTest getHzScrollBarRes getId getIdNum getInitName getMargin getMask getMaxHeight getMaxWidth getMinHeight getMinWidth getName getOpaque getOverflow getPath getPivotAsAnchor getPivotX getPivotY getPromptText getRelations getRemark getRemovedFromStageSound getReverse getReversedMask getScrollBarDisplay getScrollBarFlags getScrollBarMargin getScrollType getSelectionController getSound getSoundVolumeScale getTitleType getTransition getVtScrollBarRes getWholeNumbers getWidth isDisposed listChildren listControllers listExtensions listParents listTransitions removeChild removeController removeEventListener removeTransition setAddedToStageSound setBgColor setBgColorEnabled setBranch setBranchItemIds setButtonMode setChangeOnClick setChildrenRenderOrder setClipSoftness setCustomData setCustomProperties setDesignImageAlpha setDesignImageLayer setDesignImageOffsetX setDesignImageOffsetY setDownEffect setDownEffectValue setDropdown setExported setExtension setExtensionType setExtras setExtType setFavorite setFixedGripSize setFooterRes setHeaderRes setHitTest setHzScrollBarRes setId setIdNum setInitName setMargin setMask setMaxHeight setMaxWidth setMinHeight setMinWidth setName setOpaque setOverflow setPath setPivotAsAnchor setPivotX setPivotY setPromptText setRelations setRemark setRemovedFromStageSound setReverse setReversedMask setScrollBarDisplay setScrollBarFlags setScrollBarMargin setScrollType setSelectionController setSize setSound setSoundVolumeScale setTitleType setVtScrollBarRes setWholeNumbers
    propertyType: COMPONENT

    • Parameters

      • type: string
      • listener: EventListener<GraphNodeEvent>

      Returns this

    • Removes all inbound references to this object. At the end of the process the object is considered 'detached': it may hold references to child resources, but nothing holds references to it. A detached object may be re-attached.

      Returns this

    • Dispatches an event on the GraphNode, and on the associated Graph. Event types on the graph are prefixed, "node:[type]".

      Parameters

      • event: BaseEvent

      Returns this

    • Removes both inbound references to and outbound references from this object. At the end of the process the object holds no references, and nothing holds references to it. A disposed object is not reusable.

      Returns void

    • Returns true if the node has been permanently removed from the graph.

      Returns boolean

    • Parameters

      • type: string
      • listener: EventListener<GraphNodeEvent>

      Returns this

    Settings
    Member Visibility

    On This Page
    Properties
    Methods
    addChildaddControlleraddEventListeneraddRelationaddTransitionclonecopydetachdispatchEventdisposeequalsgetAddedToStageSoundgetBgColorgetBgColorEnabledgetBranchgetBranchItemIdsgetButtonModegetChangeOnClickgetChildgetChildByIdgetChildrenRenderOrdergetClipSoftnessgetControllergetCustomDatagetCustomPropertiesgetDesignImageAlphagetDesignImageLayergetDesignImageOffsetXgetDesignImageOffsetYgetDownEffectgetDownEffectValuegetDropdowngetExportedgetExtensiongetExtensionTypegetExtrasgetExtTypegetFavoritegetFixedGripSizegetFooterResgetHeaderResgetHeightgetHitTestgetHzScrollBarResgetIdgetIdNumgetInitNamegetMargingetMaskgetMaxHeightgetMaxWidthgetMinHeightgetMinWidthgetNamegetOpaquegetOverflowgetPathgetPivotAsAnchorgetPivotXgetPivotYgetPromptTextgetRelationsgetRemarkgetRemovedFromStageSoundgetReversegetReversedMaskgetScrollBarDisplaygetScrollBarFlagsgetScrollBarMargingetScrollTypegetSelectionControllergetSoundgetSoundVolumeScalegetTitleTypegetTransitiongetVtScrollBarResgetWholeNumbersgetWidthisDisposedlistChildrenlistControllerslistExtensionslistParentslistTransitionsremoveChildremoveControllerremoveEventListenerremoveTransitionsetAddedToStageSoundsetBgColorsetBgColorEnabledsetBranchsetBranchItemIdssetButtonModesetChangeOnClicksetChildrenRenderOrdersetClipSoftnesssetCustomDatasetCustomPropertiessetDesignImageAlphasetDesignImageLayersetDesignImageOffsetXsetDesignImageOffsetYsetDownEffectsetDownEffectValuesetDropdownsetExportedsetExtensionsetExtensionTypesetExtrassetExtTypesetFavoritesetFixedGripSizesetFooterRessetHeaderRessetHitTestsetHzScrollBarRessetIdsetIdNumsetInitNamesetMarginsetMasksetMaxHeightsetMaxWidthsetMinHeightsetMinWidthsetNamesetOpaquesetOverflowsetPathsetPivotAsAnchorsetPivotXsetPivotYsetPromptTextsetRelationssetRemarksetRemovedFromStageSoundsetReversesetReversedMasksetScrollBarDisplaysetScrollBarFlagssetScrollBarMarginsetScrollTypesetSelectionControllersetSizesetSoundsetSoundVolumeScalesetTitleTypesetVtScrollBarRessetWholeNumbers