Package | feathers.controls |
Class | public class TextCallout |
Inheritance | TextCallout ![]() ![]() ![]() ![]() ![]() ![]() ![]() |
Implements | IToolTip |
Product Version : | Feathers 3.0.0 |
Callout
designed to display text.
In the following example, a text callout is shown when a
Button
is triggered:
button.addEventListener( Event.TRIGGERED, button_triggeredHandler ); function button_triggeredHandler( event:Event ):void { var button:Button = Button( event.currentTarget ); Callout.show( "Hello World", button ); }
See also
Property | Defined By | ||
---|---|---|---|
![]() | addedEffect : Function
An optional effect that is activated when the component is added to
the stage. | FeathersControl | |
![]() | alpha : Number The opacity of the object. | DisplayObject | |
![]() | 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 | |
![]() | bounds : Rectangle [read-only] The bounds of the object relative to the local coordinates of the parent. | DisplayObject | |
calloutFactory : Function [static]
Returns a new TextCallout instance when
TextCallout.show() is called. | TextCallout | ||
![]() | 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
or the origin'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
or the origin's bounds. | 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 | |
![]() | depth : int [read-only]
The component's depth in the display list, relative to the stage. | FeathersControl | |
![]() | disposeContent : Boolean = true
Determines if the callout's content will be disposed when the callout
is disposed. | Callout | |
![]() | disposeOnSelfClose : Boolean = true
Determines if the callout will be disposed when close()
is called internally. | Callout | |
![]() | effectsSuspended : Boolean [read-only]
Indicates if effects have been suspended. | FeathersControl | |
![]() | explicitHeight : Number [read-only]
The height value explicitly set by passing a value to the
height setter or by calling the setSize()
function. | FeathersControl | |
![]() | explicitMaxHeight : Number [read-only]
The maximum height value explicitly set by passing a value to the
maxHeight setter. | FeathersControl | |
![]() | explicitMaxWidth : Number [read-only]
The maximum width value explicitly set by passing a value to the
maxWidth setter. | FeathersControl | |
![]() | explicitMinHeight : Number [read-only]
The minimum height value explicitly set by passing a value to the
minHeight setter. | FeathersControl | |
![]() | explicitMinWidth : Number [read-only]
The minimum width value explicitly set by passing a value to the
minWidth setter. | FeathersControl | |
![]() | explicitWidth : Number [read-only]
The width value explicitly set by passing a value to the
width setter or to the setSize() method. | FeathersControl | |
![]() | filter : FragmentFilter The filter that is attached to the display object. | DisplayObject | |
![]() | focusInEffect : Function
An optional effect that is activated when the component receives
focus. | FeathersControl | |
![]() | focusManager : IFocusManager
The implementation of this property is provided for convenience,
but it cannot be used unless a subclass implements the
IFocusDisplayObject interface.
The current focus manager for this component. | FeathersControl | |
![]() | focusOutEffect : Function
An optional effect that is activated when the component loses focus. | FeathersControl | |
![]() | focusOwner : IFocusDisplayObject
The implementation of this property is provided for convenience,
but it cannot be used unless a subclass implements the
IFocusDisplayObject interface.
Used for associating focusable display objects that are not direct
children with an "owner" focusable display object, such as pop-ups. | FeathersControl | |
globalStyleProvider : IStyleProvider [static]
The default IStyleProvider for all Label
components. | TextCallout | ||
![]() | height : Number [override]
The height of the component, in pixels. | FeathersControl | |
![]() | hideEffect : Function
An optional effect that is activated when the component is hidden. | FeathersControl | |
![]() | includeInLayout : Boolean
Determines if the ILayout should use this object or ignore it. | FeathersControl | |
![]() | is3D : Boolean [read-only] Indicates if this object or any of its parents is a 'Sprite3D' object. | DisplayObject | |
![]() | isCreated : Boolean [read-only]
Determines if the component has been initialized and validated for
the first time. | FeathersControl | |
![]() | isEnabled : Boolean
Indicates whether the control is interactive or not. | FeathersControl | |
![]() | isFocusEnabled : Boolean
The implementation of this property is provided for convenience,
but it cannot be used unless a subclass implements the
IFocusDisplayObject interface.
Determines if this component can receive focus. | FeathersControl | |
![]() | isInitialized : Boolean [read-only]
Determines if the component has been initialized yet. | FeathersControl | |
![]() | isQuickHitAreaEnabled : Boolean
Similar to mouseChildren on the classic display list. | FeathersControl | |
![]() | isShowingFocus : Boolean [read-only]
The implementation of this method is provided for convenience, but
it cannot be used unless a subclass implements the
IFocusDisplayObject interface.
Indicates if the showFocus() method has been called on
the object when it has focus. | FeathersControl | |
![]() | layoutData : ILayoutData
Extra parameters associated with this display object that will be
used by the layout algorithm. | FeathersControl | |
![]() | maintainTouchFocus : Boolean [read-only]
The implementation of this method is provided for convenience, but
it cannot be used unless a subclass implements the
IFocusDisplayObject interface.
If true, the display object should remain in focus,
even if something else is touched. | FeathersControl | |
![]() | mask : DisplayObject The display object that acts as a mask for the current object. | DisplayObject | |
![]() | maskInverted : Boolean Indicates if the masked region of this object is set to be inverted. | DisplayObject | |
![]() | 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 | |
![]() | moveEffect : Function
An optional effect that is activated when the component is moved to
a new position. | FeathersControl | |
![]() | name : String The name of the display object (default: null). | DisplayObject | |
![]() | nextDownFocus : IFocusDisplayObject
The implementation of this property is provided for convenience,
but it cannot be used unless a subclass implements the
IFocusDisplayObject interface.
The next object that will receive focus when
Keyboard.DOWN is pressed at
KeyLocation.D_PAD and a focus manager is enabled. | FeathersControl | |
![]() | nextLeftFocus : IFocusDisplayObject
The implementation of this property is provided for convenience,
but it cannot be used unless a subclass implements the
IFocusDisplayObject interface.
The next object that will receive focus when
Keyboard.LEFT is pressed at
KeyLocation.D_PAD and a focus manager is enabled. | FeathersControl | |
![]() | nextRightFocus : IFocusDisplayObject
The implementation of this property is provided for convenience,
but it cannot be used unless a subclass implements the
IFocusDisplayObject interface.
The next object that will receive focus when
Keyboard.RIGHT is pressed at
KeyLocation.D_PAD and a focus manager is enabled. | FeathersControl | |
![]() | nextTabFocus : IFocusDisplayObject
The implementation of this property is provided for convenience,
but it cannot be used unless a subclass implements the
IFocusDisplayObject interface.
The next object that will receive focus when the tab key is pressed
when a focus manager is enabled. | FeathersControl | |
![]() | nextUpFocus : IFocusDisplayObject
The implementation of this property is provided for convenience,
but it cannot be used unless a subclass implements the
IFocusDisplayObject interface.
The next object that will receive focus when
Keyboard.UP is pressed at
KeyLocation.D_PAD and a focus manager is enabled. | FeathersControl | |
![]() | numChildren : int [read-only] The number of children of this container. | DisplayObjectContainer | |
![]() | origin : DisplayObject
A callout may be positioned relative to another display object, known
as the callout's origin. | 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 | |
![]() | previousTabFocus : IFocusDisplayObject
The implementation of this property is provided for convenience,
but it cannot be used unless a subclass implements the
IFocusDisplayObject interface.
The previous object that will receive focus when the tab key is
pressed while holding shift when a focus manager is enabled. | FeathersControl | |
![]() | requiresRedraw : Boolean [read-only] Indicates if the object needs to be redrawn in the upcoming frame, i.e. | DisplayObject | |
![]() | resizeEffect : Function
An optional effect that is activated when the component is resized
with new dimensions. | FeathersControl | |
![]() | 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 | |
![]() | scale : Number Sets both 'scaleX' and 'scaleY' to the same value. | DisplayObject | |
![]() | scaleX : Number The horizontal scale factor. | DisplayObject | |
![]() | scaleY : Number The vertical scale factor. | DisplayObject | |
![]() | showEffect : Function
An optional effect that is activated when the component is shown. | FeathersControl | |
![]() | 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 | |
![]() | stagePadding : Number [static]
Quickly sets all stage padding properties to the same value. | Callout | |
![]() | 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 | |
![]() | styleName : String
The concatenated styleNameList, with values separated
by spaces. | FeathersControl | |
![]() | styleNameList : TokenList [read-only]
Contains a list of all "styles" assigned to this control. | FeathersControl | |
![]() | styleProvider : IStyleProvider
When a component initializes, a style provider may be used to set
properties that affect the component's visual appearance. | FeathersControl | |
![]() | supportedPositions : Vector.<String>
The position of the callout, relative to its origin. | Callout | |
text : String
The text to display in the callout. | TextCallout | ||
textRendererFactory : Function
A function used to instantiate the callout's text renderer
sub-component. | TextCallout | ||
![]() | toolTip : String
Text to display in a tool tip to when hovering over this component,
if the ToolTipManager is enabled. | FeathersControl | |
![]() | touchable : Boolean Indicates if this object (and its children) will receive touch events. | DisplayObject | |
![]() | touchGroup : Boolean If a container is a 'touchGroup', it will act as a single touchable object. | DisplayObjectContainer | |
![]() | transformationMatrix : Matrix The transformation matrix of the object relative to its parent. | DisplayObject | |
![]() | transformationMatrix3D : Matrix3D [read-only] The 3D 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 |
Property | Defined By | ||
---|---|---|---|
![]() | actualHeight : Number = 0
The final height value that should be used for layout. | FeathersControl | |
![]() | actualMinHeight : Number = 0
The final minimum height value that should be used for layout. | FeathersControl | |
![]() | actualMinWidth : Number = 0
The final minimum width value that should be used for layout. | FeathersControl | |
![]() | actualWidth : Number = 0
The final width value that should be used for layout. | FeathersControl | |
![]() | defaultStyleProvider : IStyleProvider [read-only]
When the FeathersControl constructor is called, the
styleProvider property is set to this value. | FeathersControl | |
textRenderer : ITextRenderer
The text renderer. | TextCallout | ||
textRendererStyleName : String = feathers-text-callout-text-renderer
The value added to the styleNameList of the text
renderer sub-component. | TextCallout |
Method | Defined By | ||
---|---|---|---|
Constructor. | TextCallout | ||
![]() | Adds a child to the container. | DisplayObjectContainer | |
![]() | Adds a child to the container at a certain index. | DisplayObjectContainer | |
![]() | addEventListener(type:String, listener:Function):void [override] Registers an event listener at a certain object. | DisplayObject | |
![]() | alignPivot(horizontalAlign:String = center, verticalAlign:String = center):void Moves the pivot point to a certain position within the local coordinate system
of the object. | DisplayObject | |
![]() | broadcastEvent(event:Event):void Dispatches an event on all children (recursively). | DisplayObjectContainer | |
![]() | broadcastEventWith(eventType: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
TextCallout.show() is called. | TextCallout | ||
![]() | 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. | DisplayObjectContainer | |
![]() | drawToBitmapData(out:BitmapData = null, color:uint = 0x0, alpha:Number = 0.0):BitmapData Draws the object into a BitmapData object. | DisplayObject | |
![]() | getBounds(targetSpace:DisplayObject, resultRect:Rectangle = null):Rectangle [override]
Feathers components use an optimized getBounds()
implementation that may sometimes behave differently than regular
Starling display objects. | FeathersControl | |
![]() | 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, out:Matrix = null):Matrix Creates a matrix that represents the transformation from the local coordinate system
to another. | DisplayObject | |
![]() | getTransformationMatrix3D(targetSpace:DisplayObject, out:Matrix3D = null):Matrix3D Creates a matrix that represents the transformation from the local coordinate system
to another. | DisplayObject | |
![]() | globalToLocal(globalPoint:Point, out:Point = null):Point Transforms a point from global (stage) coordinates to the local coordinate system. | DisplayObject | |
![]() | globalToLocal3D(globalPoint:Point, out:Vector3D = null):Vector3D Transforms a point from global (stage) coordinates to the 3D local coordinate system. | DisplayObject | |
![]() | hasEventListener(type:String, listener:Function = null):Boolean If called with one argument, figures out if there are any listeners registered for
the given event type. | EventDispatcher | |
![]() | hideFocus():void
The implementation of this method is provided for convenience, but
it cannot be used unless a subclass implements the
IFocusDisplayObject interface.
| FeathersControl | |
![]() | hitTest(localPoint:Point):DisplayObject [override] Returns the object that is found topmost beneath a point in local coordinates, or nil
if the test fails. | DisplayObjectContainer | |
![]() | hitTestMask(localPoint:Point):Boolean Checks if a certain point is inside the display object's mask. | DisplayObject | |
![]() | initializeNow():void
If the component has not yet initialized, initializes immediately. | FeathersControl | |
![]() | invalidate(flag:String):void
Call this function to tell the UI control that a redraw is pending. | FeathersControl | |
![]() | isInvalid(flag:String = null):Boolean
Indicates whether the control is pending validation or not. | FeathersControl | |
![]() | local3DToGlobal(localPoint:Vector3D, out:Point = null):Point Transforms a 3D point from the local coordinate system to global (stage) coordinates. | DisplayObject | |
![]() | localToGlobal(localPoint:Point, out:Point = null):Point Transforms a point from the local coordinate system to global (stage) coordinates. | DisplayObject | |
![]() | move(x:Number, y:Number):void
Sets both the x and the y positions of the control in a single
function call. | FeathersControl | |
![]() | 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 [override] Removes an event listener from the object. | DisplayObject | |
![]() | removeEventListeners(type:String = null):void [override] Removes all event listeners with a certain type, or all of them if type is null. | DisplayObject | |
![]() | removeFromParent(dispose:Boolean = false):void Removes the object from its parent, if it has one, and optionally disposes it. | DisplayObject | |
![]() | removeFromParentWithEffect(effect:Function, dispose:Boolean = false):void
Plays an effect before removing the component from its parent. | FeathersControl | |
![]() | [override] Renders the display object with the help of a painter object. | DisplayObjectContainer | |
![]() | resetStyleProvider():void
Resets the styleProvider property to its default value,
which is usually the global style provider for the component. | FeathersControl | |
![]() | resumeEffects():void
Indicates that effects should be re-activated after being suspended. | FeathersControl | |
![]() | setChildIndex(child:DisplayObject, index:int):void Moves a child to a certain index. | DisplayObjectContainer | |
![]() | setRequiresRedraw():void Forces the object to be redrawn in the next frame. | DisplayObject | |
![]() | setSize(width:Number, height:Number):void
Sets both the width and the height of the control in a single
function call. | FeathersControl | |
show(text:String, origin:DisplayObject, supportedPositions:Vector.<String> = null, isModal:Boolean = true, customCalloutFactory:Function = null, customOverlayFactory:Function = null):TextCallout [static]
Creates a callout that displays some text, and then positions and
sizes it automatically based on an origin rectangle and the specified
positions, relative to the origin. | TextCallout | ||
![]() | showFocus():void
The implementation of this method is provided for convenience, but
it cannot be used unless a subclass implements the
IFocusDisplayObject interface.
| FeathersControl | |
![]() | sortChildren(compareFunction:Function):void Sorts the children according to a given function (that works just like the sort function
of the Vector class). | DisplayObjectContainer | |
![]() | suspendEffects():void
Indicates that effects should not be activated temporarily. | FeathersControl | |
![]() | Swaps the indexes of two children. | DisplayObjectContainer | |
![]() | swapChildrenAt(index1:int, index2:int):void Swaps the indexes of two children. | DisplayObjectContainer | |
![]() | validate():void
Immediately validates the display object, if it is invalid. | FeathersControl |
Method | Defined By | ||
---|---|---|---|
![]() | autoSizeIfNeeded():Boolean
If the component's dimensions have not been set explicitly, it will
measure its content and determine an ideal size for itself. | Callout | |
![]() | clearInvalidationFlag(flag:String):void
Clears an invalidation flag. | FeathersControl | |
createTextRenderer():void
Creates and adds the textRenderer sub-component and
removes the old instance, if one exists. | TextCallout | ||
![]() | draw():void
Override to customize layout and to adjust properties of children. | FeathersControl | |
![]() | focusInHandler(event:Event):void
Default event handler for FeathersEventType.FOCUS_IN
that may be overridden in subclasses to perform additional actions
when the component receives focus. | FeathersControl | |
![]() | focusOutHandler(event:Event):void
Default event handler for FeathersEventType.FOCUS_OUT
that may be overridden in subclasses to perform additional actions
when the component loses focus. | FeathersControl | |
![]() | ignoreNextStyleRestriction():void
The next style that is set will not be restricted. | FeathersControl | |
![]() | initialize():void
Called the first time that the UI control is added to the stage, and
you should override this function to customize the initialization
process. | FeathersControl | |
![]() | processStyleRestriction(key:Object):Boolean
Used by setters for properties that are considered "styles" to
determine if the setter has been called directly on the component or
from a style provider. | FeathersControl | |
![]() | refreshFocusIndicator():void
Updates the focus indicator skin by showing or hiding it and
adjusting its position and dimensions. | FeathersControl | |
![]() | saveMeasurements(width:Number, height:Number, minWidth:Number = 0, minHeight:Number = 0):Boolean
Saves the dimensions and minimum dimensions calculated for the
component. | FeathersControl | |
![]() | setInvalidationFlag(flag:String):void
Sets an invalidation flag. | FeathersControl | |
![]() | setSizeInternal(width:Number, height:Number, canInvalidate:Boolean):Boolean
Sets the width and height of the control, with the option of
invalidating or not. | 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. | TextCallout | |||
![]() | Dispatched after the component has validated for the first time. | FeathersControl | ||
![]() | Dispatched once every frame on every object that is connected to the stage. | DisplayObject | ||
![]() | Dispatched after initialize() has been called, but before the first time that draw() has been called. | FeathersControl | ||
![]() | Dispatched when a key on the keyboard is pressed. | DisplayObject | ||
![]() | Dispatched when a key on the keyboard is released. | DisplayObject | ||
![]() | 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 |
Style | Description | Defined By | ||
---|---|---|---|---|
![]() | Type: Number The offset, in pixels, of the arrow skin from the horizontal center or vertical middle of the background skin, depending on the position of the arrow (which side it is on). See also | Callout | ||
![]() | Type: String The position of the callout's arrow relative to the callout's background. See also | Callout | ||
![]() | Type: starling.display.DisplayObject The primary background to display behind the callout's content. | Callout | ||
![]() | Type: Number The space, in pixels, between the bottom arrow skin and the background skin. See also | Callout | ||
![]() | Type: starling.display.DisplayObject The arrow skin to display on the bottom edge of the callout. See also | Callout | ||
customTextRendererStyleName | Type: String A style name to add to the callout's text renderer sub-component. Typically used by a theme to provide different styles to different callouts. In the following example, a custom text renderer style name is passed to the callout:
button.customTextRendererStyleName = "my-custom-text-callout-text-renderer";
In your theme, you can target this sub-component style name to provide different styles than the default:
getStyleProviderForClass( BitmapFontTextRenderer ).setFunctionForStyleName( "my-custom-text-callout-text-renderer", setCustomTextCalloutTextRendererStyles );
The default value is null .See also | TextCallout | ||
disabledFontStyles | Type: starling.text.TextFormat The font styles used to display the callout's text when the callout is disabled. In the following example, the disabled font styles are customized:
callout.disabledFontStyles = new TextFormat( "Helvetica", 20, 0x999999 );
Note: The null .See also | TextCallout | ||
![]() | Type: starling.display.DisplayObject If this component supports focus, this optional skin will be displayed above the component when showFocus() is called.See also | FeathersControl | ||
![]() | Type: Number Quickly sets all focus padding properties to the same value. See also | FeathersControl | ||
![]() | Type: Number The minimum space, in pixels, between the object's bottom edge and the bottom edge of the focus indicator skin. See also | FeathersControl | ||
![]() | Type: Number The minimum space, in pixels, between the object's left edge and the left edge of the focus indicator skin. See also | FeathersControl | ||
![]() | Type: Number The minimum space, in pixels, between the object's right edge and the right edge of the focus indicator skin. See also | FeathersControl | ||
![]() | Type: Number The minimum space, in pixels, between the object's top edge and the top edge of the focus indicator skin. See also | FeathersControl | ||
fontStyles | Type: starling.text.TextFormat The font styles used to display the callout's text. In the following example, the font styles are customized:
callout.fontStyles = new TextFormat( "Helvetica", 20, 0xcc0000 );
Note: The null .See also | TextCallout | ||
![]() | Type: String The horizontal alignment of the callout, relative to the origin. See also | Callout | ||
![]() | Type: Number The space, in pixels, between the right arrow skin and the background skin. See also | Callout | ||
![]() | Type: starling.display.DisplayObject The arrow skin to display on the left edge of the callout. See also | Callout | ||
![]() | Type: Number The space, in pixels, between the callout and the origin. See also | Callout | ||
![]() | Type: Number Quickly sets all padding properties to the same value. See also | Callout | ||
![]() | Type: Number The minimum space, in pixels, between the callout's bottom edge and the callout's content. See also | Callout | ||
![]() | Type: Number The minimum space, in pixels, between the callout's left edge and the callout's content. See also | Callout | ||
![]() | Type: Number The minimum space, in pixels, between the callout's right edge and the callout's content. See also | Callout | ||
![]() | Type: Number The minimum space, in pixels, between the callout's top edge and the callout's content. See also | Callout | ||
![]() | Type: Number The space, in pixels, between the right arrow skin and the background skin. See also | Callout | ||
![]() | Type: starling.display.DisplayObject The arrow skin to display on the right edge of the callout. See also | Callout | ||
![]() | Type: Number The space, in pixels, between the top arrow skin and the background skin. See also | Callout | ||
![]() | Type: starling.display.DisplayObject The arrow skin to display on the top edge of the callout. See also | Callout | ||
![]() | Type: String The vertical alignment of the callout, relative to the origin. See also | Callout | ||
wordWrap | Type: Boolean Determines if the text wraps to the next line when it reaches the width (or max width) of the component. In the following example, the text is not wrapped:
label.wordWrap = false;
The default value is true . | TextCallout |
Constant | Defined By | ||
---|---|---|---|
DEFAULT_CHILD_STYLE_NAME_TEXT_RENDERER : String = feathers-text-callout-text-renderer [static]
The default value added to the styleNameList of the text
renderer sub-component. | TextCallout | ||
![]() | DEFAULT_POSITIONS : Vector.<String> [static]
The default positions used by a callout. | 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_FOCUS : String = focus [static]
Invalidation flag to indicate that the focus of 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 |
calloutFactory | property |
public static var calloutFactory:Function
Returns a new TextCallout
instance when
TextCallout.show()
is called. If one wishes to skin the
callout manually or change its behavior, a custom factory may be
provided.
This function is expected to have the following signature:
function():TextCallout
The following example shows how to create a custom text callout factory:
TextCallout.calloutFactory = function():TextCallout { var callout:TextCallout = new TextCallout(); //set properties here! return callout; };
Note: the default callout factory sets the following properties:
callout.closeOnTouchBeganOutside = true; callout.closeOnTouchEndedOutside = true; callout.closeOnKeys = new <uint>[Keyboard.BACK, Keyboard.ESCAPE];
See also
globalStyleProvider | property |
public static var globalStyleProvider:IStyleProvider
The default IStyleProvider
for all Label
components.
The default value is null
.
See also
text | property |
text:String
The text to display in the callout.
public function get text():String
public function set text(value:String):void
textRenderer | property |
textRendererFactory | property |
textRendererFactory:Function
A function used to instantiate the callout's text renderer
sub-component. By default, the callout will use the global text
renderer factory, FeathersControl.defaultTextRendererFactory()
,
to create the text renderer. The text renderer must be an instance of
ITextRenderer
. This factory can be used to change
properties on the text renderer when it is first created. For
instance, if you are skinning Feathers components without a theme,
you might use this factory to style the text renderer.
The factory should have the following function signature:
function():ITextRenderer
In the following example, a custom text renderer factory is passed to the callout:
callout.textRendererFactory = function():ITextRenderer { return new TextFieldTextRenderer(); }
The default value is null
.
public function get textRendererFactory():Function
public function set textRendererFactory(value:Function):void
See also
textRendererStyleName | property |
protected var textRendererStyleName:String = feathers-text-callout-text-renderer
The value added to the styleNameList
of the text
renderer sub-component. This variable is protected
so
that sub-classes can customize the label text renderer style name in
their constructors instead of using the default style name defined by
DEFAULT_CHILD_STYLE_NAME_TEXT_RENDERER
.
To customize the text renderer style name without subclassing, see
customTextRendererStyleName
.
See also
TextCallout | () | Constructor |
public function TextCallout()
Constructor.
createTextRenderer | () | method |
protected function createTextRenderer():void
Creates and adds the textRenderer
sub-component and
removes the old instance, if one exists.
Meant for internal use, and subclasses may override this function with a custom implementation.
See also
defaultCalloutFactory | () | method |
public static function defaultCalloutFactory():TextCallout
The default factory that creates callouts when
TextCallout.show()
is called. To use a different
factory, you need to set TextCallout.calloutFactory
to a
Function
instance.
TextCallout |
show | () | method |
public static function show(text:String, origin:DisplayObject, supportedPositions:Vector.<String> = null, isModal:Boolean = true, customCalloutFactory:Function = null, customOverlayFactory:Function = null):TextCallout
Creates a callout that displays some text, and then positions and sizes it automatically based on an origin rectangle and the specified positions, relative to the origin.
In the following example, a text callout is shown when a
Button
is triggered:
button.addEventListener( Event.TRIGGERED, button_triggeredHandler ); function button_triggeredHandler( event:Event ):void { var button:Button = Button( event.currentTarget ); TextCallout.show( "Hello World", button ); }
Parameters
text:String | |
origin:DisplayObject | |
supportedPositions:Vector.<String> (default = null )
| |
isModal:Boolean (default = true )
| |
customCalloutFactory:Function (default = null )
| |
customOverlayFactory:Function (default = null )
|
TextCallout |
close | Event |
starling.events.Event
starling.events.Event.CLOSE
Dispatched when the callout is closed.
The properties of the event object have the following values:
Property | Value |
---|---|
bubbles | false |
currentTarget | The Object that defines the
event listener that handles the event. For example, if you use
myButton.addEventListener() to register an event listener,
myButton is the value of the currentTarget . |
data | null |
target | The Object that dispatched the event;
it is not always the Object listening for the event. Use the
currentTarget property to always access the Object
listening for the event. |
DEFAULT_CHILD_STYLE_NAME_TEXT_RENDERER | Constant |
public static const DEFAULT_CHILD_STYLE_NAME_TEXT_RENDERER:String = feathers-text-callout-text-renderer
The default value added to the styleNameList
of the text
renderer sub-component.
See also