Packagecom.ghostwire.ui.controls
Classpublic class uiInteractiveItem
InheritanceuiInteractiveItem Inheritance uiButton Inheritance uiComponent Inheritance flash.display.Sprite

uiInteractiveItem is used as the container of the renderer of an item in list-based or menu components. uiInteractiveItem in itself is not the renderer. The renderer is used to paint the "face" of this uiInteractiveItem container and can be any (suitable) uiComponent instance. The renderer class must be specified when instantiating the uiInteractiveItem object, otherwise the com.ghostwire.ui.controls.uiText class is used by default.

You would typically not use this class directly in your user interface.

~ This class is available in Aspire UI Components Lite Edition ~



Public Properties
 PropertyDefined by
 InheritedalignX : Number
Indicates how the component would like to be aligned horizontally within its allocated space.
uiComponent
 InheritedalignY : Number
Indicates how the component would like to be aligned vertically within its allocated space.
uiComponent
 Inheritedbackground : Object
Indicates the style of the background for this component.
uiComponent
 Inheritedcontainer : uiComponent
Indicates the uiComponent instance that contains this instance.
uiComponent
 Inheriteddata : Object
Indicates the data to be associated with this button.
uiButton
 Inheriteddepth : int
Indicates how deep the component is in the containment hierarchy.
uiComponent
 InheriteddesiredAllocationHeight : int
Indicates the vertical space this component would like to be allocated.
uiComponent
 InheriteddesiredAllocationWidth : int
Indicates the horizontal space this component would like to be allocated.
uiComponent
 InheriteddisplaceX : int
Indicates the amount of pixels to move any embedded child object horizontally to the right when the button is pressed down.
uiButton
 InheriteddisplaceY : int
Indicates the amount of pixels to move any embedded child object vertically downwards when the button is pressed down.
uiButton
 Inheritedenabled : Boolean
Indicates whether the component is enabled for user interaction.
uiComponent
 InheritedfillX : Boolean
Indicates whether or not the component should automatically expand or shrink to fill its allocated horizontal space.
uiComponent
 InheritedfillY : Boolean
Indicates whether or not the component should automatically expand or shrink to fill its allocated vertical space.
uiComponent
 InheritedfocusPadding : Object
Indicates the thickness of the interior space from the edge of the component to the focus rectangle.
uiComponent
 InheritedfocusRect : Object
Indicates the class to use when rendering the rectangle around the component to indicate that it is in focus.
uiComponent
 Inheritedgroup : uiButtonGroup
Indicates the uiButtonGroup this button is assigned to.
uiButton
 Inheritedheight : Number
Indicates the current height of the component.
uiComponent
  itemAlignX : Number
Indicates the horizontal aligment of the embedded child item renderer.
uiInteractiveItem
  itemAlignY : Number
Indicates the vertical aligment of the embedded child item renderer.
uiInteractiveItem
 Inheritedmargin : Object
Indicates the thickness of the space surrounding the component.
uiComponent
 InheritedmaxHeight : int
Indicates the upper limit for height.
uiComponent
 InheritedmaxWidth : int
Indicates the upper limit for width.
uiComponent
 InheritedminHeight : int
Indicates the lower limit for height.
uiComponent
 InheritedminWidth : int
Indicates the lower limit for width.
uiComponent
  owner : uiComponent
[read-only] Indicates the owner of this uiInteractiveItem instance.
uiInteractiveItem
 Inheritedpadding : Object
Indicates the thickness of the interior space from the edge of the component to the content area, which is where child components, if any, are contained.
uiComponent
  renderer : Class
Indicates the class that is used to represent the data in this uiInteractiveItem.
uiInteractiveItem
 Inheritedselected : Boolean
Indicates whether the button is selected; applicable only if the toggle property is set to true.
uiButton
 Inheritedskin : String
Indicates the name of the skin to use for this component instance.
uiComponent
 Inheritedstretch : Boolean
Indicates whether surplus space available in the parent container should be allocated to this component.
uiComponent
 InheritedtextStyle : String
Indicates the style to use for uiText instances contained in this component.
uiComponent
 Inheritedtoggle : Boolean
Indicates whether the button should toggle its selected property value between true and false when it is clicked.
uiButton
 InheritedtoolTip : Object
Indicates the content (text) of the tooltip that should be shown when the mouse hovers over this control.
uiComponent
 Inheriteduiskin : uiBitmapImage
Returns the uiBitmapImage rendered as the skin - for advanced users only.
uiComponent
 Inheritedvisible : Boolean
Indicates whether or not the component is visible within its container.
uiComponent
 Inheritedwidth : Number
Indicates the current width of the component.
uiComponent
Public Methods
 MethodDefined by
  
uiInteractiveItem(owner:uiComponent, renderer:Class = null)
Constructor - creates a new uiInteractiveItem instance.
uiInteractiveItem
 Inherited
activate(noEvent:Boolean = false):void
Activates and gives focus to the button as if the button has been clicked on (a MouseEvent.CLICK event will be dispatched).
uiButton
 Inherited
invalidate(type:String):void
Invalidates this component's "size", "display", "layout" or "textstyle".
uiComponent
 Inherited
move(x:Number, y:Number, noEvent:Boolean = false):void
Moves the component to the specified position, disregarding its allocation.
uiComponent
 Inherited
removeAllChildren(all:Boolean = false):void
Removes all children from this component.
uiComponent
 Inherited
setFocus(flag:Boolean = true):void
Gives this component instance the focus; the component must be on the display list and has its tabEnabled property set to true, otherwise this method will fail silently.
uiComponent
 Inherited
setSize(width:Number, height:Number, noEvent:Boolean = false):void
Sets this component's size to the specified width and height.
uiComponent
 Inherited
setVisible(value:Boolean, noEvent:Boolean = false):void
Sets the visibility of this component instance, dispatching a "show" or "hide" event accordingly.
uiComponent
 Inherited
validateNow():void
Validates and render the component instance, and any component instances with depth higher than itself in the validation queue, immediately.
uiComponent
Events
 EventSummaryDefined by
 Inherited Dispatched when the selected property changes.uiButton
 Inherited Dispatched when the button is activated, either by user clicking on it or pressing the SPACE key while the button is in focus.uiButton
 Inherited Dispatched when the component's visible property is changed from true to false via calling the setVisible() method.uiComponent
   Dispatched when the user interacts with the uiInteractiveItem object.uiInteractiveItem
 Inherited Dispatched when the component's position within its parent container has changed via calling the move() method.uiComponent
 Inherited Dispatched when the component's size has changed via calling the setSize() method.uiComponent
 Inherited Dispatched when the component's visible property is changed from false to true via calling the setVisible() method.uiComponent
Property detail
itemAlignXproperty
itemAlignX:Number  [read-write]

Indicates the horizontal aligment of the embedded child item renderer.

Implementation
    public function get itemAlignX():Number
    public function set itemAlignX(value:Number):void

See also

itemAlignYproperty 
itemAlignY:Number  [read-write]

Indicates the vertical aligment of the embedded child item renderer.

Implementation
    public function get itemAlignY():Number
    public function set itemAlignY(value:Number):void

See also

ownerproperty 
owner:uiComponent  [read-only]

Indicates the owner of this uiInteractiveItem instance. The owner is the list-based or menu uiComponent instance containing the item.

Implementation
    public function get owner():uiComponent
rendererproperty 
renderer:Class  [read-write]

Indicates the class that is used to represent the data in this uiInteractiveItem. By default, com.ghostwire.ui.controls.uiText is used. Effectively, this class is used to instantiate the single child of this uiInteractiveItem instance, rendering the data associated with this item.

Mapping of data properties to renderer properties must be done via the owner's dataMap property. If dataMap property is not defined (or does not exist), we will map "label" property (if it exists) in the data object to "text" property in the renderer (if applicable), and "image" property (if it exists) in the data object to "image" property in the renderer (if applicable).

Implementation
    public function get renderer():Class
    public function set renderer(value:Class):void
Constructor detail
uiInteractiveItem()constructor
public function uiInteractiveItem(owner:uiComponent, renderer:Class = null)

Constructor - creates a new uiInteractiveItem instance.

Parameters
owner:uiComponent — The uiComponent instance using this uiInteractiveItem instance.
 
renderer:Class (default = null) — The class that is used to represent the data in this item. By default, com.ghostwire.ui.controls.uiText is used. Effectively, this class is used to instantiate the single child of this uiInteractiveItem instance, rendering the data associated with this item. Mapping of data properties to renderer properties must be done via the owner's dataMap property. If dataMap is not defined, we will map "label" property (if it exists) in the data object to "text" property in the renderer (if applicable), and "image" property (if it exists) in the data object to "image" property in the renderer (if applicable).
Event detail
interactionevent 
Event object type: com.ghostwire.ui.events.uiInteractiveItemEvent.INTERACTION
INTERACTION.type property = com.ghostwire.ui.events.uiInteractiveItemEvent.INTERACTION

Dispatched when the user interacts with the uiInteractiveItem object.

Dispatched when the user interacts with an uiInteractiveItem.

This event has the following properties:

PropertyValue
bubblesfalse
cancelablefalse; there is no default behavior to cancel.
currentTargetThe object that is actively processing the event object with an event listener.
targetThe object that dispatched the event. The target is not always the object listening for the event. Use the currentTarget property to access the object that is listening for the event.
itemA data object representing the interactive item.
mouseEventThe MouseEvent event object that triggered this event.