Label  - AS3 Flex

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

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

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

デフォルト値： false;。

このプロパティはデータバインディングのソースとして使用できます。 このプロパティを変更すると、 condenseWhiteChanged イベントが送出されます。

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

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

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

デフォルト値： null。

このプロパティはデータバインディングのソースとして使用できます。 このプロパティを変更すると、 dataChange イベントが送出されます。

関連する API エレメント

このコンポーネントのフォントコンテキストを提供するモジュールファクトリです。

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 つの方法があります。

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

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

  myLabel_initialize メソッドは、次のようにスクリプトの CDATA セクションに記述します。

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

  マークアップの読みやすさが保たれるので、これが最も単純な方法です。 ラベルに id を割り当てて、initialize ハンドラーでそのラベルを参照できるようにする必要があります。

• CDATA セクションで子タグを使用して、htmlText プロパティを指定します。 XML の CDATA セクションには、< や > などの文字が特別な意味を持たない文字データが含まれます。

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

  htmlText プロパティは、<mx:Label> タグでは属性ではなく子タグとして記述する必要があります。これは、XML では属性の値に CDATA を使用できないためです。 マークアップは読み取れますが、CDATA セクションではこの方法は複雑になります。

• 属性値内の HTML マークアップ文字 < と > が書き込まれるところでは、hmtlText 属性を使用します。XML エンティティの < と > は使用しません。

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

  HTML マークアップの読み取りがほとんど不可能になるので、この方法はお勧めしません。

condenseWhite プロパティが true の場合、htmlText プロパティが設定されていると、複数の空白文字は、HTML 対応ブラウザーと同じように圧縮されます。例えば、3 つの連続するスペースは、1 つのスペースとして表示されます。 condenseWhite の既定値は false なので、空白文字を圧縮するには condenseWhite を true に設定する必要があります。

htmlText プロパティの設定直後にそれを読み込んだ場合は、設定したものと同じストリングが取得されます。 ただし、LayoutManager の実行後には、値は変更され、CSS スタイルを含むマークアップが追加されます。

htmlText プロパティの設定は、様々な方法で text プロパティに影響を与えます。 text プロパティの読み込みをhtmlText プロパティの設定直後に行うと、null が取得されます。これは、text（新しい htmlText に対応）がまだ決定されていないことを示します。 ただし、LayoutManager を実行すると、text プロパティの値は、htmlText ストリングからすべての HTML マークアップが削除されたストリングに変更されます。つまり、Label に実際に表示される文字になります。

逆に、text プロパティを設定しても、すでに設定されている htmlText はどれも無関係です。 htmlText プロパティの読み込みを text プロパティの設定直後に行うと、null が取得されます。これは、htmlText（新しい text に対応）がまだ決定されていないことを示します。 ただし、LayoutManager を実行すると、htmlText プロパティの値は、新しいテキストに CSS スタイルの HTML マークアップが追加された値に変更されます。

LayoutManager をただちに実行するには、Label で validateNow() メソッドを呼び出します。 例えば、何らかの htmlText を設定し、validateNow() メソッドを呼び出し、HTML マークアップを含まない、対応する text を直ちに取得できます。

ActionScript の中に text プロパティと htmlText プロパティの両方を設定した場合は、最後に設定されたプロパティが有効になります。 MXML では両方設定しないでください。これは、MXML ではインスタンスのプロパティの取得を特定の順序で設定することが保証されていないためです。

text プロパティまたは htmlText プロパティをループの中に設定すると処理が速くなります。これは、テキストを実際に表示する TextField が、LayoutManager が実行されるまでは更新されないためです。

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

デフォルト値： ""。

このプロパティはデータバインディングのソースとして使用できます。 このプロパティを変更すると、 htmlTextChanged イベントが送出されます。

関連する API エレメント

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

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

デフォルト値： null。

このプロパティはデータバインディングのソースとして使用できます。 このプロパティを変更すると、 dataChange イベントが送出されます。

関連する API エレメント

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

Label コントロールで link イベントが指定されている場合は、selectable プロパティを true に設定して link イベントを実行する必要があります。

デフォルト値： false;。

Label コントロールのテキスト上でレンダリングを実行できる flash.text.StyleSheet オブジェクトです。このプロパティは、テキストに対する HTML スタイルを詳細に制御する場合に使用します。詳細については、flash.text.StyleSheet クラスの説明を参照してください。

デフォルト値： null。

関連する API エレメント

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

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

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

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

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

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

デフォルト値： ""。

このプロパティはデータバインディングのソースとして使用できます。 このプロパティを変更すると、 valueCommit イベントが送出されます。

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

テキストの高さです。

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

関連する API エレメント

テキストの幅です。

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

関連する API エレメント

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

デフォルト値： true。

コンストラクターです。

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

パラメーター

関連する API エレメント

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

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

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

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

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

Label コントロールで selectable プロパティを true に設定して link イベントを生成できるようにする必要があります。

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