| パッケージ | flash.text.engine |
| クラス | public class ContentElement |
| 継承 | ContentElement Object |
| サブクラス | GraphicElement, GroupElement, TextElement |
| 言語バージョン: | ActionScript 3.0 |
| ランタイムバージョン: | Flash Player 10, AIR 1.5 |
ContentElement は抽象基本クラスであるため、ContentElement を直接インスタンス化することはできません。new ContentElement() を呼び出すと ArgumentError 例外がスローされます。
ContentElement エレメントは、1 つの GroupElement にだけ、または 1 つのテキストブロックの content にだけ割り当てることができます。
関連項目
| プロパティ | 定義元 | ||
|---|---|---|---|
![]() | constructor : Object 指定されたオブジェクトインスタンスのクラスオブジェクトまたはコンストラクタ関数への参照です。 | Object | |
| elementFormat : ElementFormat エレメントに使用される ElementFormat オブジェクトです。 | ContentElement | ||
| eventMirror : EventDispatcher このコンテンツエレメントに基づいた有効なテキスト行に送出されるすべてのイベントのコピーを受け取る EventDispatcher オブジェクトです。 | ContentElement | ||
| groupElement : GroupElement [読み取り専用] このエレメントを含む GroupElement オブジェクトです。グループ内に存在しない場合は null になります。 | ContentElement | ||
![]() | prototype : Object [静的] クラスまたは関数オブジェクトのプロトタイプオブジェクトへの参照です。 | Object | |
| rawText : String [読み取り専用] U+FDEF 文字を含む、エレメント内のテキストのコピーです。 | ContentElement | ||
| text : String [読み取り専用] String 内でグラフィックエレメントを表す U+FDEF 文字を含まない、エレメント内のテキストのコピーです。 | ContentElement | ||
| textBlock : TextBlock [読み取り専用] このエレメントが含まれる TextBlock です。 | ContentElement | ||
| textBlockBeginIndex : int [読み取り専用] このエレメントの最初の文字のテキストブロック内のインデックスです。 | ContentElement | ||
| textRotation : String エレメントを単位として適用される回転です。 | ContentElement | ||
| userData : * 作成者が任意のデータをエレメントに関連付けるための方法を提供します。 | ContentElement | ||
| メソッド | 定義元 | ||
|---|---|---|---|
ContentElement(elementFormat:ElementFormat = null, eventMirror:EventDispatcher = null, textRotation:String = "rotate0") new ContentElement() コンストラクタを呼び出すと、ArgumentError 例外がスローされます。 | ContentElement | ||
![]() | オブジェクトに指定されたプロパティが定義されているかどうかを示します。 | Object | |
![]() | Object クラスのインスタンスが、パラメータとして指定されたオブジェクトのプロトタイプチェーン内にあるかどうかを示します。 | Object | |
![]() | 指定されたプロパティが存在し、列挙できるかどうかを示します。 | Object | |
![]() | ループ処理に対するダイナミックプロパティの可用性を設定します。 | Object | |
![]() | 指定されたオブジェクトのストリング表現を返します。 | Object | |
![]() | 指定されたオブジェクトのプリミティブな値を返します。 | Object | |
| 定数 | 定義元 | ||
|---|---|---|---|
| GRAPHIC_ELEMENT : uint = 0xFDEF [静的] テキスト内にグラフィックエレメントが存在するかどうかを示します。 | ContentElement | ||
| elementFormat | プロパティ |
elementFormat:ElementFormat [読み書き可能] | 言語バージョン: | ActionScript 3.0 |
| ランタイムバージョン: | Flash Player 10, AIR 1.5 |
エレメントに使用される ElementFormat オブジェクトです。
デフォルト値は null です。
elementFormat プロパティが設定されているときは、提供された ElementFormat オブジェクトがロックされます。その locked プロパティは true に設定されます。 ロックされた ElementFormat を変更することはできません。
public function get elementFormat():ElementFormat public function set elementFormat(value:ElementFormat):void関連項目
| eventMirror | プロパティ |
eventMirror:EventDispatcher [読み書き可能] | 言語バージョン: | ActionScript 3.0 |
| ランタイムバージョン: | Flash Player 10, AIR 1.5 |
このコンテンツエレメントに基づいた有効なテキスト行に送出されるすべてのイベントのコピーを受け取る EventDispatcher オブジェクトです。実行時に行のどの部分が特定のコンテンツエレメントに基づいて作成されたかを判断することは困難な場合があるため、指定されたオブジェクトを使用して、テキストのテキストリンクまたは他のインタラクティブ要素に対するリスナーを設定できます。リスナーを使用して、下線やテキストがレイアウトされるまで決定できないメトリックなど文字飾りを適用することもできます。 デフォルト値は null です。これは、ミラーされるイベントが送出されないことを意味します。
イベントミラーは、TextLineMirrorRegion クラスのインスタンスなどのテキスト行に明示されます。双方向処理および改行によって、1 つ以上のミラー領域が作成されます。
デフォルト値は null です。
public function get eventMirror():EventDispatcher public function set eventMirror(value:EventDispatcher):void関連項目
| groupElement | プロパティ |
groupElement:GroupElement [読み取り専用] | 言語バージョン: | ActionScript 3.0 |
| ランタイムバージョン: | Flash Player 10, AIR 1.5 |
このエレメントを含む GroupElement オブジェクトです。グループ内に存在しない場合は null になります。
デフォルト値は null です。
public function get groupElement():GroupElement関連項目
| rawText | プロパティ |
rawText:String [読み取り専用] | 言語バージョン: | ActionScript 3.0 |
| ランタイムバージョン: | Flash Player 10, AIR 1.5 |
U+FDEF 文字を含む、エレメント内のテキストのコピーです。U+FDEF 文字は、String 内のグラフィックエレメントを表す任意の文字です。
public function get rawText():String| text | プロパティ |
text:String [読み取り専用] | 言語バージョン: | ActionScript 3.0 |
| ランタイムバージョン: | Flash Player 10, AIR 1.5 |
String 内でグラフィックエレメントを表す U+FDEF 文字を含まない、エレメント内のテキストのコピーです。
public function get text():String関連項目
| textBlock | プロパティ |
textBlock:TextBlock [読み取り専用] | 言語バージョン: | ActionScript 3.0 |
| ランタイムバージョン: | Flash Player 10, AIR 1.5 |
このエレメントが含まれる TextBlock です。
デフォルト値は null です。
public function get textBlock():TextBlock関連項目
| textBlockBeginIndex | プロパティ |
textBlockBeginIndex:int [読み取り専用] | 言語バージョン: | ActionScript 3.0 |
| ランタイムバージョン: | Flash Player 10, AIR 1.5 |
このエレメントの最初の文字のテキストブロック内のインデックスです。この値はキャッシュされません。このメソッドが呼び出されるたびに算出されます。
デフォルト値は -1 です。
public function get textBlockBeginIndex():int| textRotation | プロパティ |
textRotation:String [読み書き可能] | 言語バージョン: | ActionScript 3.0 |
| ランタイムバージョン: | Flash Player 10, AIR 1.5 |
エレメントを単位として適用される回転です。このプロパティには、TextRotation 定数を使用します。
デフォルト値は、TextRotation.ROTATE_0 です。
任意の文字の最終的な回転は、ElementFormat.textRotation、ContentElement.textRotation および TextBlock.lineRotation の合計になります。
ContentElement.textRotation は、それを含む行とは回転が異なる短いテキストを作成するために使用されます。日本語テキスト内の TCY(縦中横)のテキスト範囲は、この一例です。TCY とは、縦、中、横を表しており、縦書きの日本語テキストの中で使用される小さな横書きのテキスト(通常は数字)です。TCY のテキスト範囲を含む、縦書きの日本語テキストの Paragraph を作成するには、次の処理を行います。
TextBlock.lineRotation=TextRotation.ROTATE_90 と設定します。
TextBlock.content を、GroupElement(3 つのTextElement オブジェクトで構成される)に設定します。 これらのエレメントのうち、1 番目は TCY のテキスト範囲の前にある日本語テキスト、2 番目は TCY のラテン語のテキスト範囲、3 番目は TCY のテキスト範囲の後にある日本語テキストです。
textRotation プロパティ(TCY の TextElement)を TextRotation.ROTATE_270 に設定します。 TCY のテキストエレメントは、単位として回転します。この回転は、行から継承された 90 度回転で開始されます。さらに 270 度回転させると、水平方向に戻ります。
回転したコンテンツエレメントは、ネストできません。コンテンツエレメントのどの階層でも、複雑さの程度に関係なく、1 つのコンテンツエレメントの textRotation プロパティだけを設定できます。以下のメソッドおよびプロパティの setter は、ネストされた回転が検出されると引数エラーをスローします。
ContentElement.textRotation
GroupElement.setElements
GroupElement.replaceElements
このプロパティの値を設定するには、次のストリング値を使用します。
| ストリング値 | 説明 |
|---|---|
TextRotation.ROTATE_0
| エレメントは、回転されません。 |
TextRotation.ROTATE_90
| エレメントは時計回りに 90 度回転します。 |
TextRotation.ROTATE_180
| エレメントは 180 度回転します。 |
TextRotation.ROTATE_270
| エレメントは時計回りに 270 度回転します。 |
TextRotation.AUTO
| サポートされません。 |
public function get textRotation():String public function set textRotation(value:String):voidArgumentError —
TextRotation のメンバーではないいずれかの値に設定する場合。
| |
ArgumentError —
TextRotation.AUTO に設定する場合。
| |
ArgumentError —
処理の結果、GroupElement 内で回転がネストする場合。
|
関連項目
| userData | プロパティ |
public var userData:*| 言語バージョン: | ActionScript 3.0 |
| ランタイムバージョン: | Flash Player 10, AIR 1.5 |
作成者が任意のデータをエレメントに関連付けるための方法を提供します。
デフォルト値は null です。
| ContentElement | () | コンストラクタ |
public function ContentElement(elementFormat:ElementFormat = null, eventMirror:EventDispatcher = null, textRotation:String = "rotate0")| 言語バージョン: | ActionScript 3.0 |
| ランタイムバージョン: | Flash Player 10, AIR 1.5 |
new ContentElement() コンストラクタを呼び出すと、ArgumentError 例外がスローされます。 ただし、次に示す ContentElement のサブクラスについては、コンストラクタを呼び出すことができます。
new GraphicElement()
new GroupElement()
new TextElement()
elementFormat:ElementFormat (default = null) —
エレメント内のテキストのエレメント形式です。デフォルト値は null です。
| |
eventMirror:EventDispatcher (default = null) —
このコンテンツエレメントに基づいて作成された有効なテキスト行に送出されるすべてのイベントのコピーを受け取る EventDispatcher オブジェクトです。 デフォルト値は null です。
| |
textRotation:String (default = "rotate0") —
エレメントを単位として適用される回転です。このプロパティには、TextRotation 定数を使用します。デフォルト値は、TextRotation.ROTATE_0 です。
|
| GRAPHIC_ELEMENT | 定数 |
public static const GRAPHIC_ELEMENT:uint = 0xFDEF| 言語バージョン: | ActionScript 3.0 |
| ランタイムバージョン: | Flash Player 10, AIR 1.5 |
テキスト内にグラフィックエレメントが存在するかどうかを示します。
関連項目