Packagejp.progression.core.ui
Classpublic class ToolTip
InheritanceToolTip Inheritance Object

ToolTip クラスは、基本的なツールチップを提供する表示オブジェクトクラスです。 ToolTip クラスを直接インスタンス化することはできません。 new ToolTip() コンストラクタを呼び出すと、ArgumentError 例外がスローされます。

View the examples



Public Properties
 PropertyDefined By
  backgroundColor : uint
ツールチップの背景色を取得または設定します。
ToolTip
  borderColor : uint
ツールチップのボーダー色を取得または設定します。
ToolTip
  defaultTextFormat : TextFormat
新しく挿入するテキスト (replaceSelectedText() メソッドで挿入したテキストまたはユーザーが入力したテキストなど) に適用するフォーマットを指定します。 Specifies the format applied to newly inserted text, such as text inserted with the replaceSelectedText() method or text entered by a user.
ToolTip
  delay : int
ツールチップを表示するまでの遅延時間をミリ秒で取得または設定します。 An indexed array that contains each filter object currently associated with the ToolTip object.
ToolTip
  enabled : Boolean
[read-only] ツールチップが使用可能かどうかを取得します。
ToolTip
  filters : Array
ツールチップに現在関連付けられている各フィルタオブジェクトが格納されているインデックス付きの配列です。
ToolTip
  followMouse : Boolean
表示されたツールチップが対象にロールオーバーしている際に、マウスカーソルに追従するかどうかを取得または設定します。
ToolTip
  friction : Number
followMouse プロパティが有効化された際の摩擦係数を取得または設定します。
ToolTip
  text : String
ツールチップに表示するテキストを取得または設定します。 この値が設定されていない場合には、ツールチップは表示されません。
ToolTip
  textColor : uint
表示するテキストの色を取得または設定します。
ToolTip
  textFont : String
表示するテキストのフォントを取得または設定します。
ToolTip
Public Methods
 MethodDefined By
  
setTextFormat(format:TextFormat, beginIndex:int = -1, endIndex:int = -1):void
format パラメータで指定したテキストフォーマットを、ツールチップ内の指定されたテキストに適用します。 Applies the text formatting that the format parameter specifies to the specified text in a tool tip.
ToolTip
  
toString():String
指定されたオブジェクトのストリング表現を返します。 Returns the string representation of the specified object.
ToolTip
Property Detail
backgroundColorproperty
backgroundColor:uint

ツールチップの背景色を取得または設定します。


Implementation
    public function get backgroundColor():uint
    public function set backgroundColor(value:uint):void
borderColorproperty 
borderColor:uint

ツールチップのボーダー色を取得または設定します。


Implementation
    public function get borderColor():uint
    public function set borderColor(value:uint):void
defaultTextFormatproperty 
defaultTextFormat:TextFormat

新しく挿入するテキスト (replaceSelectedText() メソッドで挿入したテキストまたはユーザーが入力したテキストなど) に適用するフォーマットを指定します。 Specifies the format applied to newly inserted text, such as text inserted with the replaceSelectedText() method or text entered by a user.


Implementation
    public function get defaultTextFormat():TextFormat
    public function set defaultTextFormat(value:TextFormat):void
delayproperty 
delay:int

ツールチップを表示するまでの遅延時間をミリ秒で取得または設定します。 An indexed array that contains each filter object currently associated with the ToolTip object.


Implementation
    public function get delay():int
    public function set delay(value:int):void
enabledproperty 
enabled:Boolean  [read-only]

ツールチップが使用可能かどうかを取得します。


Implementation
    public function get enabled():Boolean
filtersproperty 
filters:Array

ツールチップに現在関連付けられている各フィルタオブジェクトが格納されているインデックス付きの配列です。


Implementation
    public function get filters():Array
    public function set filters(value:Array):void
followMouseproperty 
followMouse:Boolean

表示されたツールチップが対象にロールオーバーしている際に、マウスカーソルに追従するかどうかを取得または設定します。


Implementation
    public function get followMouse():Boolean
    public function set followMouse(value:Boolean):void
frictionproperty 
friction:Number

followMouse プロパティが有効化された際の摩擦係数を取得または設定します。


Implementation
    public function get friction():Number
    public function set friction(value:Number):void
textproperty 
text:String

ツールチップに表示するテキストを取得または設定します。 この値が設定されていない場合には、ツールチップは表示されません。


Implementation
    public function get text():String
    public function set text(value:String):void
textColorproperty 
textColor:uint

表示するテキストの色を取得または設定します。


Implementation
    public function get textColor():uint
    public function set textColor(value:uint):void
textFontproperty 
textFont:String

表示するテキストのフォントを取得または設定します。


Implementation
    public function get textFont():String
    public function set textFont(value:String):void
Method Detail
setTextFormat()method
public function setTextFormat(format:TextFormat, beginIndex:int = -1, endIndex:int = -1):void

format パラメータで指定したテキストフォーマットを、ツールチップ内の指定されたテキストに適用します。 Applies the text formatting that the format parameter specifies to the specified text in a tool tip.

Parameters

format:TextFormat文字と段落のフォーマット情報を含む TextFormat オブジェクトです。 A TextFormat object that contains character and paragraph formatting information.
 
beginIndex:int (default = -1)必要なテキスト範囲の最初の文字を指定する 0 から始まるインデックス位置です。 Optional; an integer that specifies the zero-based index position specifying the first character of the desired range of text.
 
endIndex:int (default = -1)必要なテキスト範囲の最初の文字を指定する 0 から始まるインデックス位置です。 Optional; an integer that specifies the first character after the desired text span. As designed, if you specify beginIndex and endIndex values, the text from beginIndex to endIndex-1 is updated.

toString()method 
public function toString():String

指定されたオブジェクトのストリング表現を返します。 Returns the string representation of the specified object.

Returns
Stringオブジェクトのストリング表現です。 A string representation of the object.
Examples