condenseWhite:Boolean  [read-write]

HTML テキストの Label コントロールから余分な空白文字 (スペースや改行など) を削除するかどうかを指定します。

condenseWhite プロパティは、text プロパティではなく htmlText プロパティで設定されたテキストにのみ影響します。text プロパティでテキストを設定した場合、condenseWhite は無視されます。

condenseWhite プロパティを true に設定した場合は、テキストフィールド内で改行を指定するときに <br> や <p> などの標準の HTML コマンドを使用する必要があります。

デフォルト値false;.

このプロパティはデータバインディングのソースとして使用できます。

実装
    public function get condenseWhite():Boolean
    public function set condenseWhite(value:Boolean):void

data:Object  [read-write]

アイテムレンダラーまたはアイテムエディタでコンポーネントを使用するときに、コンポーネントに値を渡すことができます。通常、データバインディングを使用して、data プロパティのフィールドをこのコンポーネントのプロパティにバインドします。

ドロップインアイテムレンダラーまたはドロップインアイテムエディタとしてコントロールを使用すると、アイテムの現在の値が、このコントロールの text プロパティに自動的に書き込まれます。

MXML でこのプロパティを設定することはありません。

デフォルト値ヌル (null).

このプロパティはデータバインディングのソースとして使用できます。

実装
    public function get data():Object
    public function set data(value:Object):void

関連項目

htmlText:String  [read-write]

Label コントロールによって表示されるテキストを指定します。テキストのスタイルを表す HTML マークアップも一緒に指定します。このプロパティで HTML テキストを指定する場合は、Flash TextField コントロールでサポートされている HTML タグのサブセットを使用できます。

このプロパティを設定すると、Label インスタンスに CSS スタイルが適用された後に HTML マークアップが適用されます。このプロパティを取得すると、HTML マークアップに CSS スタイルが含まれます。

たとえば、"This is an example of <b>bold</b> markup",という文字列を設定した場合、Label には、通常適用される CSS スタイルが適用された 「This is an example of bold markup」というテキストが表示されます。また、<b> マークアップによって、"bold" という単語がボールド体のフォントで表示されます。

HTML マークアップでは、< や > などの文字を使用します。これらの文字は、XML では特別な意味を持っています (MXML でも同じです) 。したがって、次のようなコードはコンパイルされません。

      <mx:Label htmlText="This is an example of <b>bold</b> markup"/>
      

この問題を回避するには、3 つの方法があります。

• initialize ハンドラとして呼び出される ActionScript メソッドの htmlText プロパティを設定します。

        <mx:Label id="myLabel" initialize="myLabel_initialize()"/>
        

  myLabel_initialize メソッドは、スクリプトの CDATA セクションに指定します。

        <mx:Script>
        <![CDATA[
        private function myLabel_initialize():void {
            myLabel.htmlText = "This is an example of <b>bold</b> markup";
        }
        ]]>
        </mx:Script>
        
        

  This is the simplest approach because the HTML markup remains easily readable. Notice that you must assign an id to the label so you can refer to it in the initialize handler.

• Specify the htmlText property by using a child tag with a CDATA section. A CDATA section in XML contains character data where characters like < and > aren't given a special meaning.

        <mx:Label>
            <mx:htmlText><![CDATA[This is an example of <b>bold</b> markup]]></mx:htmlText>
        <mx:Label/>
        

  You must write the htmlText property as a child tag rather than as an attribute on the <mx:Label> tag because XML doesn't allow CDATA for the value of an attribute. Notice that the markup is readable, but the CDATA section makes this approach more complicated.

• Use an hmtlText attribute where any occurences of the HTML markup characters < and > in the attribute value are written instead as the XML "entities" < and >:

        <mx:Label htmlText="This is an example of &lt;b&gt;bold&lt;/b&gt; markup"/&gt;
        

  Adobe does not recommend this approach because the HTML markup becomes nearly impossible to read.

If the condenseWhite property is true when you set the htmlText property, multiple white-space characters are condensed, as in HTML-based browsers; for example, three consecutive spaces are displayed as a single space. The default value for condenseWhite is false, so you must set condenseWhite to true to collapse the white space.

If you read back the htmlText property quickly after setting it, you get the same string that you set. However, after the LayoutManager runs, the value changes to include additional markup that includes the CSS styles.

Setting the htmlText property affects the text property in several ways. If you read the text property quickly after setting the htmlText property, you get null, which indicates that the text corresponding to the new htmlText has not yet been determined. However, after the LayoutManager runs, the text property value changes to the htmlText string with all the HTML markup removed; that is, the value is the characters that the Label actually displays.

Conversely, if you set the text property, any previously set htmlText is irrelevant. If you read the htmlText property quickly after setting the text property, you get null, which indicates that the htmlText that corresponds to the new text has not yet been determined. However, after the LayoutManager runs, the htmlText property value changes to the new text plus the HTML markup for the CSS styles.

To make the LayoutManager run immediately, you can call the validateNow() method on the Label. For example, you could set some htmlText, call the validateNow() method, and immediately obtain the corresponding text that doesn't have the HTML markup.

If you set both text and htmlText properties in ActionScript, whichever is set last takes effect. Do not set both in MXML, because MXML does not guarantee that the properties of an instance get set in any particular order.

Setting either text or htmlText property inside a loop is a fast operation, because the underlying TextField that actually renders the text is not updated until the LayoutManager runs.

If you try to set this property to null, it is set, instead, to the empty string. If the property temporarily has the value null, it indicates that the text has been recently set and the corresponding htmlText has not yet been determined.

デフォルト値"".

このプロパティはデータバインディングのソースとして使用できます。

実装
    public function get htmlText():String
    public function set htmlText(value:String):void

関連項目

listData:BaseListData  [read-write]

ドロップインアイテムレンダラーまたはドロップインアイテムエディタとして使用すると、このコンポーネントの listData プロパティが、List コントロールからの該当するデータで初期化されます。その後、コンポーネントでこの listData プロパティを使用して、ドロップインアイテムレンダラーまたはドロップインアイテムエディタの data プロパティを初期化できます。

MXML および ActionScript でこのプロパティを設定することはありません。このコンポーネントがドロップインアイテムレンダラーまたはドロップインアイテムエディタとして使用されるときに、Flex でプロパティが設定されます。

デフォルト値ヌル (null).

このプロパティはデータバインディングのソースとして使用できます。

実装
    public function get listData():BaseListData
    public function set listData(value:BaseListData):void

関連項目

selectable:Boolean  [read-write]

テキストが選択可能であるかどうかを指定します。テキストを選択可能にすると、コントロールからテキストをコピーできます。

デフォルト値false;.

実装
    public function get selectable():Boolean
    public function set selectable(value:Boolean):void

text:String  [read-write]

このコントロールで表示されるプレーンテキストです。その外観は、この Label コントロールの CSS スタイルによって決定されます。

このプロパティを設定すると、ストリングで HTML マークアップのように見える文字が特殊な意味を持たなくなり、単に入力されたとおりの文字として表示されます。

HTML タグを使用してフォーマットされたテキストを表示するには、htmlText プロパティを使用します。htmlText プロパティを設定している場合は、その HTML で、設定されたテキストが置き換えられ、text プロパティは、HTML テキストから HTML タグを除いたプレーンテキストを返します。

特殊文字である左山括弧 (<)、右山括弧 (>)、アンパサンド (&) をテキストに含める場合は、CDATA タグでテキストストリングを囲む必要があります。特殊文字の代わりに、< などの HTML 文字エンティティを使用できます。

Label コントロールよりテキストの幅の方が大きい場合、テキストは省略記号 (...) で切り詰められ、最後まで表示されません。マウスを Label コントロール上に移動すると、テキスト全体がツールヒントとして表示されます。tooltip プロパティを使用してツールヒントを設定している場合は、テキストではなくツールヒントが表示されます。

このプロパティを null に設定しようとした場合は、代わりに空のストリングに設定されます。text プロパティには、値 null を一時的に設定できます。これは、htmlText が最近設定され、対応する text 値がまだ決定されていないことを示します。

デフォルト値"".

このプロパティはデータバインディングのソースとして使用できます。

実装
    public function get text():String
    public function set text(value:String):void

protected var textField:UITextField

この Label のテキストを表示するための内部 UITextField です。

textHeight:Number  [read-only]

テキストの高さです。

textHeight プロパティの値は、コンポーネントが検証された後でのみ正しい値になります。text を設定し、その直後に textHeight を取得した場合は、間違った値を受け取る可能性があります。コンポーネントが検証されるまで待つか、値を取得する前に validateNow() メソッドを呼び出します。この動作は、値をただちに更新する flash.text.TextField コントロールの動作とは異なります。

実装
    public function get textHeight():Number

関連項目

textWidth:Number  [read-only]

テキストの幅です。

textWidth プロパティの値は、コンポーネントが検証された後でのみ正しい値になります。text を設定し、その直後に textWidth を取得した場合は、間違った値を受け取る可能性があります。コンポーネントが検証されるまで待つか、値を取得する前に validateNow() メソッドを呼び出します。この動作は、値をただちに更新する flash.text.TextField コントロールの動作とは異なります。

実装
    public function get textWidth():Number

関連項目

public var truncateToFit:Boolean = true

このプロパティが true のときに Label コントロールのサイズがテキストよりも小さい場合、Label コントロールのテキストは切り捨てられ、"..." などのローカライズ可能文字列が使用されます。このプロパティが false の場合、コントロールに収まらないテキストは切り捨てられます。

デフォルト値true.

public 関数 Label()

コンストラクタです。

public function getLineMetrics(lineIndex:int):TextLineMetrics

コントロール内のテキスト行のテキストの位置と測定に関する情報を持つ TextLineMetrics オブジェクトを返します。正しい数値を取得するには、コンポーネントを検証する必要があります。text を設定し、その直後に getLineMetrics() を呼び出した場合は、間違った値を受け取る可能性があります。コンポーネントが検証されるまで待つか、validateNow() を呼び出します。この動作は、値をただちに更新する flash.text.TextField クラスの動作とは異なります。

パラメータ

lineIndex:int — メトリックを取得する行の 0 から始まるインデックスです。行が 1 行だけある Label コントロールでは、0 でなければなりません。

戻り値

TextLineMetrics

関連項目

イベントオブジェクトの型: mx.events.FlexEvent
FlexEvent.type property = mx.events.FlexEvent.DATA_CHANGE

data プロパティが変更されたときに送出されます。

コンポーネントをアイテムレンダラーとして使う場合、data プロパティは表示するデータを保持します。このイベントを受け取って、data プロパティが変更されたときにコンポーネントを更新することができます。

FlexEvent.DATA_CHANGE 定数により、dataChange イベントのイベントオブジェクトの type プロパティ値が定義されます。

イベントオブジェクトの各プロパティには次の値が設定されています。

プロパティ	値
bubbles	false
cancelable	false
currentTarget	イベント処理を行うイベントリスナーの定義用オブジェクトを表します。たとえば、イベントリスナーの登録に myButton.addEventListener() を使用すると、currentTarget の値は "myButton" となります。
target	イベントを送出したオブジェクトを表します。このオブジェクトは必ずイベントを受け取るオブジェクトとは限りません。イベントを受け取るオブジェクトにアクセスするには、currentTarget プロパティを使用します。

イベントオブジェクトの型: flash.events.TextEvent
TextEvent.type property = flash.events.TextEvent.LINK

HTML が有効になっているテキストフィールドで、URL が "event:" で始まるハイパーリンクをユーザーがクリックしたときに送出されます。URL の "event:" の後の残りの部分は、link イベントオブジェクトの text プロパティ内に配置されます。

link イベントの処理時にハイパーリンクは自動的には実行されません。イベントハンドラ内から手動でハイパーリンクを実行する必要があります。通常、ハイパーリンクを実行するには navigateToURL() メソッドを使用します。これにより、アプリケーション内でハイパーリンクを変更することができ、場合によってはハイパーリンクの実行を禁止することもできます。

link イベントを生成するには、Label コントロールの selectable プロパティが true に設定されている必要があります。

link イベントオブジェクトの type プロパティの値を定義します。

このイベントには、次のプロパティがあります。

プロパティ	値
bubbles	true
cancelable	false は、キャンセルするデフォルトの動作がないことを示します。
currentTarget	イベントリスナーで Event オブジェクトをアクティブに処理しているオブジェクトです。
target	クリックされたハイパーリンクを含むテキストフィールドです。target は、必ずしもイベントリスナーを登録した表示リスト内のオブジェクトとは限りません。現在イベントを処理している表示リスト内のオブジェクトにアクセスするには、currentTarget プロパティを使用します。
text	"event:" の後の URL の残りの部分は、