Package | feathers.controls |
Class | public class Callout |
Inheritance | Callout ![]() ![]() ![]() ![]() ![]() ![]() |
See also
Property | Defined By | ||
---|---|---|---|
![]() | alpha : Number The opacity of the object. | DisplayObject | |
arrowOffset : Number
The offset, in pixels, of the arrow skin from the center or middle of
the background skin. | Callout | ||
arrowPosition : String
The position of the callout's arrow relative to the background. | Callout | ||
backgroundSkin : DisplayObject
The primary background to display. | Callout | ||
![]() | base : DisplayObject [read-only] The topmost object in the display tree the object is part of. | DisplayObject | |
![]() | blendMode : String The blend mode determines how the object is blended with the objects underneath. | DisplayObject | |
bottomArrowGap : Number
The space, in pixels, between the bottom arrow skin and the
background skin. | Callout | ||
bottomArrowSkin : DisplayObject
The arrow skin to display on the bottom edge of the callout. | Callout | ||
![]() | bounds : Rectangle [read-only] The bounds of the object relative to the local coordinates of the parent. | DisplayObject | |
calloutFactory : Function [static]
Returns a new Callout instance when Callout.show()
is called with isModal set to true. | Callout | ||
calloutOverlayFactory : Function [static]
Returns an overlay to display with a callout that is modal. | Callout | ||
closeOnKeys : Vector.<uint>
The callout will be closed if any of these keys are pressed. | Callout | ||
closeOnTouchBeganOutside : Boolean = false
Determines if the callout is automatically closed if a touch in the
TouchPhase.BEGAN phase happens outside of the callout's
bounds. | Callout | ||
closeOnTouchEndedOutside : Boolean = false
Determines if the callout is automatically closed if a touch in the
TouchPhase.ENDED phase happens outside of the callout's
bounds. | Callout | ||
content : DisplayObject
The display object that will be presented by the callout. | Callout | ||
![]() | defaultTextEditorFactory : Function [static]
A function used by all UI controls that support text editor to
create an ITextEditor instance. | FeathersControl | |
![]() | defaultTextRendererFactory : Function [static]
A function used by all UI controls that support text renderers to
create an ITextRenderer instance. | FeathersControl | |
![]() | filter : FragmentFilter The filter or filter group that is attached to the display object. | DisplayObject | |
![]() | hasVisibleArea : Boolean [read-only] Indicates if an object occupies any visible area. | DisplayObject | |
![]() | height : Number [override]
The height of the component, in pixels. | FeathersControl | |
![]() | isEnabled : Boolean
Indicates whether the control is interactive or not. | FeathersControl | |
![]() | isFlattened : Boolean [read-only] Indicates if the sprite was flattened. | Sprite | |
![]() | isInitialized : Boolean [read-only]
Determines if the component has been initialized yet. | FeathersControl | |
![]() | isQuickHitAreaEnabled : Boolean
Similar to mouseChildren on the classic display list. | FeathersControl | |
leftArrowGap : Number
The space, in pixels, between the right arrow skin and the background
skin. | Callout | ||
leftArrowSkin : DisplayObject
The arrow skin to display on the left edge of the callout. | Callout | ||
![]() | maxHeight : Number
The maximum recommended height to be used for self-measurement and,
optionally, by any code that is resizing this component. | FeathersControl | |
![]() | maxWidth : Number
The maximum recommended width to be used for self-measurement and,
optionally, by any code that is resizing this component. | FeathersControl | |
![]() | minHeight : Number
The minimum recommended height to be used for self-measurement and,
optionally, by any code that is resizing this component. | FeathersControl | |
![]() | minTouchHeight : Number
If using isQuickHitAreaEnabled, and the hit area's
height is smaller than this value, it will be expanded. | FeathersControl | |
![]() | minTouchWidth : Number
If using isQuickHitAreaEnabled, and the hit area's
width is smaller than this value, it will be expanded. | FeathersControl | |
![]() | minWidth : Number
The minimum recommended width to be used for self-measurement and,
optionally, by any code that is resizing this component. | FeathersControl | |
![]() | name : String [override]
The concatenated nameList, with each name separated by
spaces. | FeathersControl | |
![]() | nameList : TokenList [read-only]
Contains a list of all "names" assigned to this control. | FeathersControl | |
![]() | numChildren : int [read-only] The number of children of this container. | DisplayObjectContainer | |
paddingBottom : Number
The minimum space, in pixels, between the callout's bottom edge and
the callout's content. | Callout | ||
paddingLeft : Number
The minimum space, in pixels, between the callout's left edge and the
callout's content. | Callout | ||
paddingRight : Number
The minimum space, in pixels, between the callout's right edge and
the callout's content. | Callout | ||
paddingTop : Number
The minimum space, in pixels, between the callout's top edge and the
callout's content. | Callout | ||
![]() | parent : DisplayObjectContainer [read-only] The display object container that contains this display object. | DisplayObject | |
![]() | pivotX : Number The x coordinate of the object's origin in its own coordinate space (default: 0). | DisplayObject | |
![]() | pivotY : Number The y coordinate of the object's origin in its own coordinate space (default: 0). | DisplayObject | |
rightArrowGap : Number
The space, in pixels, between the right arrow skin and the background
skin. | Callout | ||
rightArrowSkin : DisplayObject
The arrow skin to display on the right edge of the callout. | Callout | ||
![]() | root : DisplayObject [read-only] The root object the display object is connected to (i.e. | DisplayObject | |
![]() | rotation : Number The rotation of the object in radians. | DisplayObject | |
![]() | scaleX : Number The horizontal scale factor. | DisplayObject | |
![]() | scaleY : Number The vertical scale factor. | DisplayObject | |
![]() | skewX : Number The horizontal skew angle in radians. | DisplayObject | |
![]() | skewY : Number The vertical skew angle in radians. | DisplayObject | |
![]() | stage : Stage [read-only] The stage the display object is connected to, or null if it is not connected
to the stage. | DisplayObject | |
stagePaddingBottom : Number = 0 [static]
The padding between a callout and the bottom edge of the stage when the
callout is positioned automatically. | Callout | ||
stagePaddingLeft : Number = 0 [static]
The margin between a callout and the top edge of the stage when the
callout is positioned automatically. | Callout | ||
stagePaddingRight : Number = 0 [static]
The padding between a callout and the right edge of the stage when the
callout is positioned automatically. | Callout | ||
stagePaddingTop : Number = 0 [static]
The padding between a callout and the top edge of the stage when the
callout is positioned automatically. | Callout | ||
topArrowGap : Number
The space, in pixels, between the top arrow skin and the background
skin. | Callout | ||
topArrowSkin : DisplayObject
The arrow skin to display on the top edge of the callout. | Callout | ||
![]() | touchable : Boolean Indicates if this object (and its children) will receive touch events. | DisplayObject | |
![]() | transformationMatrix : Matrix The transformation matrix of the object relative to its parent. | DisplayObject | |
![]() | useHandCursor : Boolean Indicates if the mouse cursor should transform into a hand while it's over the sprite. | DisplayObject | |
![]() | visible : Boolean The visibility of the object. | DisplayObject | |
![]() | width : Number [override]
The width of the component, in pixels. | FeathersControl | |
![]() | x : Number The x coordinate of the object relative to the local coordinates of the parent. | DisplayObject | |
![]() | y : Number The y coordinate of the object relative to the local coordinates of the parent. | DisplayObject |
Method | Defined By | ||
---|---|---|---|
Callout()
Constructor. | Callout | ||
![]() | Adds a child to the container. | DisplayObjectContainer | |
![]() | Adds a child to the container at a certain index. | DisplayObjectContainer | |
![]() | addEventListener(type:String, listener:Function):void Registers an event listener at a certain object. | EventDispatcher | |
![]() | broadcastEvent(event:Event):void Dispatches an event on all children (recursively). | DisplayObjectContainer | |
![]() | broadcastEventWith(type:String, data:Object = null):void Dispatches an event with the given parameters on all children (recursively). | DisplayObjectContainer | |
close(dispose:Boolean = false):void
Closes the callout. | Callout | ||
![]() | contains(child:DisplayObject):Boolean Determines if a certain object is a child of the container (recursively). | DisplayObjectContainer | |
[static]
The default factory that creates callouts when Callout.show()
is called. | Callout | ||
![]() | dispatchEvent(event:Event):void Dispatches an event to all objects that have registered listeners for its type. | EventDispatcher | |
![]() | dispatchEventWith(type:String, bubbles:Boolean = false, data:Object = null):void Dispatches an event with the given parameters to all objects that have registered
listeners for the given type. | EventDispatcher | |
![]() | dispose():void [override] Disposes the resources of all children. | Sprite | |
![]() | flatten():void Optimizes the sprite for optimal rendering performance. | Sprite | |
![]() | getBounds(targetSpace:DisplayObject, resultRect:Rectangle = null):Rectangle [override] Returns a rectangle that completely encloses the object as it appears in another
coordinate system. | DisplayObjectContainer | |
![]() | getChildAt(index:int):DisplayObject Returns a child object at a certain index. | DisplayObjectContainer | |
![]() | getChildByName(name:String):DisplayObject Returns a child object with a certain name (non-recursively). | DisplayObjectContainer | |
![]() | getChildIndex(child:DisplayObject):int Returns the index of a child within the container, or "-1" if it is not found. | DisplayObjectContainer | |
![]() | getTransformationMatrix(targetSpace:DisplayObject, resultMatrix:Matrix = null):Matrix Creates a matrix that represents the transformation from the local coordinate system
to another. | DisplayObject | |
![]() | globalToLocal(globalPoint:Point, resultPoint:Point = null):Point Transforms a point from global (stage) coordinates to the local coordinate system. | DisplayObject | |
![]() | hasEventListener(type:String):Boolean Returns if there are listeners registered for a certain event type. | EventDispatcher | |
![]() | hitTest(localPoint:Point, forTouch:Boolean = false):DisplayObject [override] Returns the object that is found topmost beneath a point in local coordinates, or nil if
the test fails. | DisplayObjectContainer | |
![]() | invalidate(flag:String):void
When called, the UI control will redraw within one frame. | FeathersControl | |
![]() | isInvalid(flag:String = null):Boolean
Indicates whether the control is invalid or not. | FeathersControl | |
![]() | localToGlobal(localPoint:Point, resultPoint:Point = null):Point Transforms a point from the local coordinate system to global (stage) coordinates. | DisplayObject | |
![]() | Removes a child from the container. | DisplayObjectContainer | |
![]() | removeChildAt(index:int, dispose:Boolean = false):DisplayObject Removes a child at a certain index. | DisplayObjectContainer | |
![]() | removeChildren(beginIndex:int = 0, endIndex:int = -1, dispose:Boolean = false):void Removes a range of children from the container (endIndex included). | DisplayObjectContainer | |
![]() | removeEventListener(type:String, listener:Function):void Removes an event listener from the object. | EventDispatcher | |
![]() | removeEventListeners(type:String = null):void Removes all event listeners with a certain type, or all of them if type is null. | EventDispatcher | |
![]() | removeFromParent(dispose:Boolean = false):void Removes the object from its parent, if it has one. | DisplayObject | |
![]() | render(support:RenderSupport, parentAlpha:Number):void [override] Renders the display object with the help of a support object. | Sprite | |
![]() | setChildIndex(child:DisplayObject, index:int):void Moves a child to a certain index. | DisplayObjectContainer | |
![]() | setSize(width:Number, height:Number):void
Sets both the width and the height of the control. | FeathersControl | |
show(content:DisplayObject, origin:DisplayObject, direction:String, isModal:Boolean = true, customCalloutFactory:Function = null):Callout [static]
Creates a callout, and then positions and sizes it automatically
based on an origin rectangle and the specified direction relative to
the original. | Callout | ||
![]() | sortChildren(compareFunction:Function):void Sorts the children according to a given function (that works just like the sort function
of the Vector class). | DisplayObjectContainer | |
![]() | Swaps the indexes of two children. | DisplayObjectContainer | |
![]() | swapChildrenAt(index1:int, index2:int):void Swaps the indexes of two children. | DisplayObjectContainer | |
![]() | unflatten():void Removes the rendering optimizations that were created when flattening the sprite. | Sprite | |
![]() | validate():void
Immediately validates the control, which triggers a redraw, if one
is pending. | FeathersControl |
Event | Summary | Defined By | ||
---|---|---|---|---|
![]() | Dispatched when an object is added to a parent. | DisplayObject | ||
![]() | Dispatched when an object is connected to the stage (directly or indirectly). | DisplayObject | ||
Dispatched when the callout is closed. | Callout | |||
![]() | Dispatched once every frame on every object that is connected to the stage. | DisplayObject | ||
![]() | Dispatched on all children when the object is flattened. | Sprite | ||
![]() | Dispatched after initialize() has been called, but before the first time that draw() has been called. | FeathersControl | ||
![]() | Dispatched when an object is removed from its parent. | DisplayObject | ||
![]() | Dispatched when an object is removed from the stage and won't be rendered any longer. | DisplayObject | ||
![]() | Dispatched when the width or height of the control changes. | FeathersControl | ||
![]() | Dispatched when an object is touched. | DisplayObject |
Constant | Defined By | ||
---|---|---|---|
ARROW_POSITION_BOTTOM : String = bottom [static]
The arrow will appear on the bottom side of the callout. | Callout | ||
ARROW_POSITION_LEFT : String = left [static]
The arrow will appear on the left side of the callout. | Callout | ||
ARROW_POSITION_RIGHT : String = right [static]
The arrow will appear on the right side of the callout. | Callout | ||
ARROW_POSITION_TOP : String = top [static]
The arrow will appear on the top side of the callout. | Callout | ||
DIRECTION_ANY : String = any [static]
The callout may be positioned on any side of the origin region. | Callout | ||
DIRECTION_DOWN : String = down [static]
The callout must be positioned below the origin region. | Callout | ||
DIRECTION_LEFT : String = left [static]
The callout must be positioned to the left side of the origin region. | Callout | ||
DIRECTION_RIGHT : String = right [static]
The callout must be positioned to the right side of the origin region. | Callout | ||
DIRECTION_UP : String = up [static]
The callout must be positioned above the origin region. | Callout | ||
![]() | INVALIDATION_FLAG_ALL : String = all [static]
Flag to indicate that everything is invalid and should be redrawn. | FeathersControl | |
![]() | INVALIDATION_FLAG_DATA : String = data [static]
Invalidation flag to indicate that the primary data displayed by the
UI control has changed. | FeathersControl | |
![]() | INVALIDATION_FLAG_LAYOUT : String = layout [static]
Invalidation flag to indicate that the layout of the UI control has
changed. | FeathersControl | |
![]() | INVALIDATION_FLAG_SCROLL : String = scroll [static]
Invalidation flag to indicate that the scroll position of the UI
control has changed. | FeathersControl | |
![]() | INVALIDATION_FLAG_SELECTED : String = selected [static]
Invalidation flag to indicate that the selection of the UI control
has changed. | FeathersControl | |
![]() | INVALIDATION_FLAG_SIZE : String = size [static]
Invalidation flag to indicate that the dimensions of the UI control
have changed. | FeathersControl | |
![]() | INVALIDATION_FLAG_SKIN : String = skin [static]
Invalidation flag to indicate that the skin of the UI control has changed. | FeathersControl | |
![]() | INVALIDATION_FLAG_STATE : String = state [static]
Invalidation flag to indicate that the state has changed. | FeathersControl | |
![]() | INVALIDATION_FLAG_STYLES : String = styles [static]
Invalidation flag to indicate that the styles or visual appearance of
the UI control has changed. | FeathersControl |
arrowOffset | property |
arrowOffset:Number
The offset, in pixels, of the arrow skin from the center or middle of the background skin. On the top and bottom edges, the arrow will move left for negative values and right for positive values. On the left and right edges, the arrow will move up for negative values and down for positive values.
public function get arrowOffset():Number
public function set arrowOffset(value:Number):void
arrowPosition | property |
arrowPosition:String
The position of the callout's arrow relative to the background. Do
not confuse this with the direction that the callout opens when using
Callout.create()
.
public function get arrowPosition():String
public function set arrowPosition(value:String):void
backgroundSkin | property |
backgroundSkin:DisplayObject
The primary background to display.
public function get backgroundSkin():DisplayObject
public function set backgroundSkin(value:DisplayObject):void
bottomArrowGap | property |
bottomArrowGap:Number
The space, in pixels, between the bottom arrow skin and the background skin. To have the arrow overlap the background, you may use a negative gap value.
public function get bottomArrowGap():Number
public function set bottomArrowGap(value:Number):void
bottomArrowSkin | property |
bottomArrowSkin:DisplayObject
The arrow skin to display on the bottom edge of the callout. This arrow is displayed when the callout is displayed above the region it points at.
public function get bottomArrowSkin():DisplayObject
public function set bottomArrowSkin(value:DisplayObject):void
calloutFactory | property |
public static var calloutFactory:Function
Returns a new Callout
instance when Callout.show()
is called with isModal set to true. If one wishes to skin the callout
manually, a custom factory may be provided.
This function is expected to have the following signature:
function():Callout
calloutOverlayFactory | property |
public static var calloutOverlayFactory:Function
Returns an overlay to display with a callout that is modal.
This function is expected to have the following signature:
function():DisplayObject
See also
closeOnKeys | property |
public var closeOnKeys:Vector.<uint>
The callout will be closed if any of these keys are pressed.
closeOnTouchBeganOutside | property |
public var closeOnTouchBeganOutside:Boolean = false
Determines if the callout is automatically closed if a touch in the
TouchPhase.BEGAN
phase happens outside of the callout's
bounds.
closeOnTouchEndedOutside | property |
public var closeOnTouchEndedOutside:Boolean = false
Determines if the callout is automatically closed if a touch in the
TouchPhase.ENDED
phase happens outside of the callout's
bounds.
content | property |
content:DisplayObject
The display object that will be presented by the callout. This object may be resized to fit the callout's bounds. If the content needs to be scrolled if placed into a smaller region than its ideal size, it must provide its own scrolling capabilities because the callout does not offer scrolling.
public function get content():DisplayObject
public function set content(value:DisplayObject):void
leftArrowGap | property |
leftArrowGap:Number
The space, in pixels, between the right arrow skin and the background skin. To have the arrow overlap the background, you may use a negative gap value.
public function get leftArrowGap():Number
public function set leftArrowGap(value:Number):void
leftArrowSkin | property |
leftArrowSkin:DisplayObject
The arrow skin to display on the left edge of the callout. This arrow is displayed when the callout is displayed to the right of the region it points at.
public function get leftArrowSkin():DisplayObject
public function set leftArrowSkin(value:DisplayObject):void
paddingBottom | property |
paddingBottom:Number
The minimum space, in pixels, between the callout's bottom edge and the callout's content.
public function get paddingBottom():Number
public function set paddingBottom(value:Number):void
paddingLeft | property |
paddingLeft:Number
The minimum space, in pixels, between the callout's left edge and the callout's content.
public function get paddingLeft():Number
public function set paddingLeft(value:Number):void
paddingRight | property |
paddingRight:Number
The minimum space, in pixels, between the callout's right edge and the callout's content.
public function get paddingRight():Number
public function set paddingRight(value:Number):void
paddingTop | property |
paddingTop:Number
The minimum space, in pixels, between the callout's top edge and the callout's content.
public function get paddingTop():Number
public function set paddingTop(value:Number):void
rightArrowGap | property |
rightArrowGap:Number
The space, in pixels, between the right arrow skin and the background skin. To have the arrow overlap the background, you may use a negative gap value.
public function get rightArrowGap():Number
public function set rightArrowGap(value:Number):void
rightArrowSkin | property |
rightArrowSkin:DisplayObject
The arrow skin to display on the right edge of the callout. This arrow is displayed when the callout is displayed to the left of the region it points at.
public function get rightArrowSkin():DisplayObject
public function set rightArrowSkin(value:DisplayObject):void
stagePaddingBottom | property |
public static var stagePaddingBottom:Number = 0
The padding between a callout and the bottom edge of the stage when the callout is positioned automatically. May be ignored if the callout is too big for the stage.
stagePaddingLeft | property |
public static var stagePaddingLeft:Number = 0
The margin between a callout and the top edge of the stage when the callout is positioned automatically. May be ignored if the callout is too big for the stage.
stagePaddingRight | property |
public static var stagePaddingRight:Number = 0
The padding between a callout and the right edge of the stage when the callout is positioned automatically. May be ignored if the callout is too big for the stage.
stagePaddingTop | property |
public static var stagePaddingTop:Number = 0
The padding between a callout and the top edge of the stage when the callout is positioned automatically. May be ignored if the callout is too big for the stage.
topArrowGap | property |
topArrowGap:Number
The space, in pixels, between the top arrow skin and the background skin. To have the arrow overlap the background, you may use a negative gap value.
public function get topArrowGap():Number
public function set topArrowGap(value:Number):void
topArrowSkin | property |
topArrowSkin:DisplayObject
The arrow skin to display on the top edge of the callout. This arrow is displayed when the callout is displayed below the region it points at.
public function get topArrowSkin():DisplayObject
public function set topArrowSkin(value:DisplayObject):void
Callout | () | Constructor |
public function Callout()
Constructor.
close | () | method |
public function close(dispose:Boolean = false):void
Closes the callout.
Parameters
dispose:Boolean (default = false )
|
defaultCalloutFactory | () | method |
public static function defaultCalloutFactory():Callout
The default factory that creates callouts when Callout.show()
is called. To use a different factory, you need to set
Callout.calloutFactory
to a Function
instance.
Callout |
show | () | method |
public static function show(content:DisplayObject, origin:DisplayObject, direction:String, isModal:Boolean = true, customCalloutFactory:Function = null):Callout
Creates a callout, and then positions and sizes it automatically based on an origin rectangle and the specified direction relative to the original. The provided width and height values are optional, and these values may be ignored if the callout cannot be drawn at the specified dimensions.
Parameters
content:DisplayObject | |
origin:DisplayObject | |
direction:String (default = NaN )
| |
isModal:Boolean (default = true )
| |
customCalloutFactory:Function (default = null )
|
Callout |
close | Event |
starling.events.Event
starling.events.Event.CLOSE
Dispatched when the callout is closed.
An event type to be utilized in custom events. Not used by Starling right now.ARROW_POSITION_BOTTOM | Constant |
public static const ARROW_POSITION_BOTTOM:String = bottom
The arrow will appear on the bottom side of the callout.
ARROW_POSITION_LEFT | Constant |
public static const ARROW_POSITION_LEFT:String = left
The arrow will appear on the left side of the callout.
ARROW_POSITION_RIGHT | Constant |
public static const ARROW_POSITION_RIGHT:String = right
The arrow will appear on the right side of the callout.
ARROW_POSITION_TOP | Constant |
public static const ARROW_POSITION_TOP:String = top
The arrow will appear on the top side of the callout.
DIRECTION_ANY | Constant |
public static const DIRECTION_ANY:String = any
The callout may be positioned on any side of the origin region.
DIRECTION_DOWN | Constant |
public static const DIRECTION_DOWN:String = down
The callout must be positioned below the origin region.
DIRECTION_LEFT | Constant |
public static const DIRECTION_LEFT:String = left
The callout must be positioned to the left side of the origin region.
DIRECTION_RIGHT | Constant |
public static const DIRECTION_RIGHT:String = right
The callout must be positioned to the right side of the origin region.
DIRECTION_UP | Constant |
public static const DIRECTION_UP:String = up
The callout must be positioned above the origin region.