Packagexp.charting
Classpublic class DataTip
InheritanceDataTip Inheritance ChartComponent Inheritance mx.core.UIComponent

The ToolTip control lets you provide helpful information to your users. When a user moves the mouse pointer over a graphical component, the ToolTip control pops up and displays text that provides information about the component. You can use ToolTips to guide users as they work with your application or customize the ToolTip controls to provide additional functionality.

See also

mx.managers.ToolTipManager
mx.styles.CSSStyleDeclaration

Public Properties
 PropertyDefined by
  autoregister : Boolean = true
DataTip
  autosize : Boolean = true
DataTip
  autoSize : String
DataTip
 Inheritedchart : IChartArea
ChartComponent
 InheritedchartDesc : ChartDesc
ChartComponent
 InheritedchartParent : IChart
ChartComponent
  data : Object
DataTip
 InheritedisSubChart : Boolean
ChartComponent
  maxWidth : Number = 300
[static] Maximum width in pixels for new ToolTip controls.
DataTip
  mode : String = "label"
DataTip
  multiline : Boolean
DataTip
  selectable : Boolean
DataTip
Protected Properties
 PropertyDefined by
  _calloutRadius : int
DataTip
  _calloutStroke : IStroke
DataTip
  _calloutTickLength : int
DataTip
  _dataTipPlacement : String
DataTip
  _paddingBottom : Number
DataTip
  _paddingLeft : Number
DataTip
  _paddingRight : Number
DataTip
  _paddingTop : Number
DataTip
  _showDataTipMarker : Boolean
DataTip
  textField : UITextField
The internal UITextField that renders the text of this ToolTip.
DataTip
Public Methods
 MethodDefined by
  
DataTip()
Constructor.
DataTip
  
calcRegistrationPoint():void
DataTip
  
getClassStyleDeclarations():Array
Finds the type selectors for this UIComponent instance.
DataTip
 Inherited
initElement(chart:IChartArea):void
ChartComponent
  
move(x:Number, y:Number):void
DataTip
  
setRegistrationPoint(x:int, y:int):void
DataTip
  
validateDisplayList():void
DataTip
Protected Methods
 MethodDefined by
 Inherited
plotSizeChangedHandler(e:Event):void
ChartComponent
Styles
 StyleDescriptionDefined by
  
backgroundAlpha
Type: Number   CSS Inheritance: no
Alpha level of the color defined by the backgroundColor property, of the image or SWF file defined by the backgroundImage style. Valid values range from 0.0 to 1.0. The default value is 0.95. 		DataTip
  
backgroundAlpha
Type: Number   CSS Inheritance: no
Alpha level of the color defined by the backgroundColor property, of the image or SWF file defined by the backgroundImage style. Valid values range from 0.0 to 1.0. The default value is 1.0.		DataTip
  
backgroundColor
Type: uint   Format: Color   CSS Inheritance: no
Background color of a component. You can have both a backgroundColor and a backgroundImage set. Some components do not have a background. The DataGrid control ignores this style. The default value is undefined, which means it is not set. If both this style and the backgroundImage style are undefined, the component has a transparent background.

For the Application container, this style specifies the background color while the application loads, and a background gradient while it is running. Flex calculates the gradient pattern between a color slightly darker than the specified color, and a color slightly lighter than the specified color.

The default skins of most Flex controls are partially transparent. As a result, the background color of a container partially "bleeds through" to controls that are in that container. You can avoid this by setting the alpha values of the control's fillAlphas property to 1, as the following example shows: 

  <mx:Container backgroundColor="0x66CC66"/>
      <mx:ControlName ... fillAlphas="[1,1]"/>
  </mx:Container>

DataTip
  
backgroundDisabledColor
Type: uint   Format: Color   CSS Inheritance: yes
Background color of the component when it is disabled. The global default value is undefined. The default value for List controls is 0xDDDDDD (light gray). If a container is disabled, the background is dimmed, and the degree of dimming is controlled by the disabledOverlayAlpha style. 		DataTip
  
backgroundImage
Type: Object   Format: File   CSS Inheritance: no
Background image of a component. This can be an absolute or relative URL or class. You can either have both a backgroundColor and a backgroundImage set at the same time. The background image is displayed on top of the background color. The default value is undefined, meaning "not set". If this style and the backgroundColor style are undefined, the component has a transparent background.

The default skins of most Flex controls are partially transparent. As a result, the background image of a container partially "bleeds through" to controls that are in that container. You can avoid this by setting the alpha values of the control's fillAlphas property to 1, as the following example shows: 

  <mx:Container backgroundColor="0x66CC66"/>
      <mx:ControlName ... fillAlphas="[1,1]"/>
  </mx:Container>

DataTip
  
backgroundSize
Type: String   CSS Inheritance: no
Scales the image specified by backgroundImage to different percentage sizes. A value of "100%" stretches the image to fit the entire component. To specify a percentage value, you must include the percent sign (%). The default value is "auto", which maintains the original size of the image. 		DataTip
  
borderAlpha
Type: Number   CSS Inheritance: no
Alpha level of the color defined by the borderColor property. Valid values range from 0.0 to 1.0. The default value is 1.0.		DataTip
  
borderColor
Type: uint   Format: Color   CSS Inheritance: no
Color of the border. The default value depends on the component class; if not overridden for the class, the default value is 0xB7BABC. 		DataTip
  
borderSides
Type: String   CSS Inheritance: no
Bounding box sides. A space-delimited String that specifies the sides of the border to show. The String can contain "left", "top", "right", and "bottom" in any order. The default value is "left top right bottom", which shows all four sides. This style is only used when borderStyle is "solid". 		DataTip
  
borderSkin
Type: Class   CSS Inheritance: no
The border skin of the component. The default value is mx.skins.halo.HaloBorder.		DataTip
  
borderStyle
Type: String   CSS Inheritance: no
Bounding box style. The possible values are "none", "solid", "inset", and "outset". The default value depends on the component class; if not overridden for the class, the default value is "inset". The default value for most Containers is "none". 		DataTip
  
borderThickness
Type: Number   Format: Length   CSS Inheritance: no
Bounding box thickness. Only used when borderStyle is set to "solid". The default value is 1.		DataTip
  
calloutRadius
Type: Number   CSS Inheritance: yes
DataTip
  
calloutStroke
Type: mx.graphics.IStroke   CSS Inheritance: no
DataTip
  
calloutTickLength
Type: Number   CSS Inheritance: yes
DataTip
  
color
Type: uint   Format: Color   CSS Inheritance: yes
Color of text in the component, including the component label. The default value is 0x0B333C.		DataTip
  
cornerRadius
Type: Number   Format: Length   CSS Inheritance: no
Radius of component corners. The default value depends on the component class; if not overriden for the class, the default value is 0. The default value for ApplicationControlBar is 5. 		DataTip
  
dataTipPlacement
Type: String   CSS Inheritance: yes
DataTip
  
disabledColor
Type: uint   Format: Color   CSS Inheritance: yes
Color of text in the component if it is disabled. The default value is 0xAAB3B3.		DataTip
  
dropShadowColor
Type: uint   Format: Color   CSS Inheritance: yes
Color of the drop shadow. The default value is 0x000000.		DataTip
  
dropShadowEnabled
Type: Boolean   CSS Inheritance: no
Boolean property that specifies whether the component has a visible drop shadow. This style is used with borderStyle="solid". The default value is false.

Note: For drop shadows to appear on containers, set backgroundColor or backgroundImage properties. Otherwise, the shadow appears behind the container because the default background of a container is transparent.

DataTip
  
fontAntiAliasType
Type: String   CSS Inheritance: yes
Sets the antiAliasType property of internal TextFields. The possible values are "normal" (flash.text.AntiAliasType.NORMAL) and "advanced" (flash.text.AntiAliasType.ADVANCED).

The default value is "advanced", which enables the FlashType renderer if you are using an embedded FlashType font. Set to "normal" to disable the FlashType renderer.

This style has no effect for system fonts.

This style applies to all the text in a TextField subcontrol; you can't apply it to some characters and not others.

The default value is "advanced".		DataTip
  
fontFamily
Type: String   CSS Inheritance: yes
Name of the font to use. Unlike in a full CSS implementation, comma-separated lists are not supported. You can use any font family name. If you specify a generic font name, it is converted to an appropriate device font. The default value is "Verdana".		DataTip
  
fontGridFitType
Type: String   CSS Inheritance: yes
Sets the gridFitType property of internal TextFields that represent text in Flex controls. The possible values are "none" (flash.text.GridFitType.NONE), "pixel" (flash.text.GridFitType.PIXEL), and "subpixel" (flash.text.GridFitType.SUBPIXEL).

This property only applies when you are using an embedded FlashType font and the fontAntiAliasType property is set to "advanced".

This style has no effect for system fonts.

This style applies to all the text in a TextField subcontrol; you can't apply it to some characters and not others.

The default value is "pixel".		DataTip
  
fontSharpness
Type: Number   CSS Inheritance: yes
Sets the sharpness property of internal TextFields that represent text in Flex controls. This property specifies the sharpness of the glyph edges. The possible values are Numbers from -400 through 400.

This property only applies when you are using an embedded FlashType font and the fontAntiAliasType property is set to "advanced".

This style has no effect for system fonts.

This style applies to all the text in a TextField subcontrol; you can't apply it to some characters and not others.

The default value is 0.		DataTip
  
fontSize
Type: Number   Format: Length   CSS Inheritance: yes
Height of the text, in pixels. The default value is 10 for all controls except the ColorPicker control. For the ColorPicker control, the default value is 11. 		DataTip
  
fontStyle
Type: String   CSS Inheritance: yes
Determines whether the text is italic font. Recognized values are "normal" and "italic". The default value is "normal".		DataTip
  
fontThickness
Type: Number   CSS Inheritance: yes
Sets the thickness property of internal TextFields that represent text in Flex controls. This property specifies the thickness of the glyph edges. The possible values are Numbers from -200 to 200.

This property only applies when you are using an embedded FlashType font and the fontAntiAliasType property is set to "advanced".

This style has no effect on system fonts.

This style applies to all the text in a TextField subcontrol; you can't apply it to some characters and not others.

The default value is 0.		DataTip
  
fontWeight
Type: String   CSS Inheritance: yes
Determines whether the text is boldface. Recognized values are "normal" and "bold". For Button controls, the default is "bold". The default value is "normal".		DataTip
  
kerning
Type: Boolean   CSS Inheritance: yes
A Boolean value that indicates whether kerning is enabled (true) or disabled (false). Kerning adjusts the gap between certain character pairs to improve readability, and should be used only when necessary, such as with headings in large fonts. Kerning is supported for embedded FlashType fonts only. Certain fonts, such as Verdana, and monospaced fonts, such as Courier New, do not support kerning. The default value is false.		DataTip
  
leading
Type: Number   Format: Length   CSS Inheritance: no
Additional vertical space between lines of text.

The default value is 2.

The default value for the ComboBox control is 0.

DataTip
  
letterSpacing
Type: Number   CSS Inheritance: yes
The number of additional pixels to appear between each character. A positive value increases the character spacing beyond the normal spacing, while a negative value decreases it. The default value is 0.		DataTip
  
paddingBottom
Type: Number   Format: Length   CSS Inheritance: no
Number of pixels between the container's right border and the right edge of its content area.

The default value is 0.

DataTip
  
paddingLeft
Type: Number   Format: Length   CSS Inheritance: no
Number of pixels between the container's left border and the left edge of its content area.

The default value is 0.

DataTip
  
paddingRight
Type: Number   Format: Length   CSS Inheritance: no
Number of pixels between the container's right border and the right edge of its content area.

The default value is 0.

DataTip
  
paddingTop
Type: Number   Format: Length   CSS Inheritance: no
Number of pixels between the container's left border and the left edge of its content area.

The default value is 0.

DataTip
  
shadowDirection
Type: String   CSS Inheritance: no
Direction of the drop shadow. Possible values are "left", "center", and "right". The default value is "center".		DataTip
  
shadowDistance
Type: Number   Format: Length   CSS Inheritance: no
Distance of the drop shadow. If the property is set to a negative value, the shadow appears above the component. The default value is 2.		DataTip
  
showDataTipMarker
Type: Boolean   CSS Inheritance: yes
DataTip
  
textAlign
Type: String   CSS Inheritance: yes
Alignment of text within a container. Possible values are "left", "right", or "center".

The default value for most controls is left. For the Button, LinkButton, and AccordionHeader components, the default value is "center". For these components, this property is only recognized when the labelPlacement property is set to "left" or "right". If labelPlacement is set to "top" or "bottom", the text and any icon are centered.

DataTip
  
textDecoration
Type: String   CSS Inheritance: no
Determines whether the text is underlined. Possible values are "none" and "underline". The default value is "none".		DataTip
  
textIndent
Type: Number   Format: Length   CSS Inheritance: yes
Offset of first line of text from the left side of the container, in pixels. The default value is 0.		DataTip
Property detail
autoregisterproperty
public var autoregister:Boolean = true
autosizeproperty 
public var autosize:Boolean = true
autoSizeproperty 
public var autoSize:String
_calloutRadiusproperty 
protected var _calloutRadius:int
_calloutStrokeproperty 
protected var _calloutStroke:IStroke
_calloutTickLengthproperty 
protected var _calloutTickLength:int
dataproperty 
data:Object  [read-write]Implementation
    public function get data():Object
    public function set data(value:Object):void
_dataTipPlacementproperty 
protected var _dataTipPlacement:String
maxWidthproperty 
public static var maxWidth:Number = 300

Maximum width in pixels for new ToolTip controls.

modeproperty 
public var mode:String = "label"
multilineproperty 
public var multiline:Boolean
_paddingBottomproperty 
protected var _paddingBottom:Number
_paddingLeftproperty 
protected var _paddingLeft:Number
_paddingRightproperty 
protected var _paddingRight:Number
_paddingTopproperty 
protected var _paddingTop:Number
selectableproperty 
public var selectable:Boolean
_showDataTipMarkerproperty 
protected var _showDataTipMarker:Boolean
textFieldproperty 
protected var textField:UITextField

The internal UITextField that renders the text of this ToolTip.

Constructor detail
DataTip()constructor
public function DataTip()

Constructor.

Method detail
calcRegistrationPoint()method
public function calcRegistrationPoint():void
getClassStyleDeclarations()method 
public override function getClassStyleDeclarations():Array

Finds the type selectors for this UIComponent instance. The algorithm walks up the superclass chain. For example, suppose that class MyButton extends Button. A MyButton instance will first look for a MyButton type selector then, it will look for a Button type selector. then, it will look for a UIComponent type selector. (The superclass chain is considered to stop at UIComponent, not Object.)

Returns
Array — An Array of type selectors for this UIComponent instance.
move()method 
public override function move(x:Number, y:Number):voidParameters
x:Number
 
y:Number
setRegistrationPoint()method 
public function setRegistrationPoint(x:int, y:int):voidParameters
x:int
 
y:int
validateDisplayList()method 
public override function validateDisplayList():void