ContentElement

パッケージ	flash.text.engine
クラス	public class ContentElement
継承	ContentElement Object
サブクラス	GraphicElement, GroupElement, TextElement

言語バージョン:

ActionScript 3.0

ランタイムバージョン:

Flash Player 10, AIR 1.5, Flash Lite 4

ContentElement クラスは、GroupElement に表示されるエレメントタイプ、つまり、GraphicElement、別の GroupElement または TextElement に対する基本クラスとして機能します。

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
		rawText : String [読み取り専用] 任意の U+FDEF 文字を含む、エレメント内のテキストのコピーです。	ContentElement
		text : String [読み取り専用] String 内でグラフィックエレメントを表す、いずれの U+FDEF 文字も含まない、エレメント内のテキストのコピーです。	ContentElement
		textBlock : flash.text.engine: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
		hasOwnProperty(name:String):Boolean オブジェクトに指定されたプロパティが定義されているかどうかを示します。	Object
		isPrototypeOf(theClass:Object):Boolean Object クラスのインスタンスが、パラメーターとして指定されたオブジェクトのプロトタイプチェーン内にあるかどうかを示します。	Object
		propertyIsEnumerable(name:String):Boolean 指定されたプロパティが存在し、列挙できるかどうかを示します。	Object
		setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void ループ処理に対するダイナミックプロパティの可用性を設定します。	Object
		toLocaleString():String ロケール固有の規則に従って書式設定された、このオブジェクトのストリング表現を返します。	Object
		toString():String 指定されたオブジェクトのストリング表現を返します。	Object
		valueOf():Object 指定されたオブジェクトのプリミティブな値を返します。	Object

パブリック定数

	定数		定義元
		GRAPHIC_ELEMENT : uint = 0xFDEF [静的] テキスト内にグラフィックエレメントが存在するかどうかを示します。	ContentElement

プロパティの詳細

elementFormat

プロパティ

elementFormat:ElementFormat

言語バージョン:

ActionScript 3.0

ランタイムバージョン:

Flash Player 10, AIR 1.5, Flash Lite 4

エレメントに使用される ElementFormat オブジェクトです。

デフォルト値は null です。

elementFormat プロパティが設定されているときは、提供された ElementFormat オブジェクトがロックされます。その locked プロパティは true に設定されます。ロックされた ElementFormat を変更することはできません。

実装
public function get elementFormat():ElementFormat
public function set elementFormat(value:ElementFormat):void

関連する API エレメント

ElementFormat
TextBlock
TextElement

eventMirror

プロパティ

eventMirror:EventDispatcher

言語バージョン:

ActionScript 3.0

ランタイムバージョン:

Flash Player 10, AIR 1.5, Flash Lite 4

このコンテンツエレメントに基づいた有効なテキスト行に送出されるすべてのイベントのコピーを受け取る 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, Flash Lite 4

このエレメントを含む GroupElement オブジェクトです。グループ内に存在しない場合は null になります。

デフォルト値は null です。

実装
public function get groupElement():GroupElement

関連する API エレメント

GroupElement

rawText

プロパティ

rawText:String [読み取り専用]

言語バージョン:

ActionScript 3.0

ランタイムバージョン:

Flash Player 10, AIR 1.5, Flash Lite 4

任意の U+FDEF 文字を含む、エレメント内のテキストのコピーです。Unicode 文字、U+FDEF は、String 内のグラフィックエレメントの位置をマークします。

実装
public function get rawText():String

text

プロパティ

text:String [読み取り専用]

言語バージョン:

ActionScript 3.0

ランタイムバージョン:

Flash Player 10, AIR 1.5, Flash Lite 4

String 内でグラフィックエレメントを表す、いずれの U+FDEF 文字も含まない、エレメント内のテキストのコピーです。

実装
public function get text():String

関連する API エレメント

TextElement.text

textBlock

プロパティ

textBlock:flash.text.engine:TextBlock [読み取り専用]

言語バージョン:

ActionScript 3.0

ランタイムバージョン:

Flash Player 10, AIR 1.5, Flash Lite 4

このエレメントが含まれる TextBlock です。

デフォルト値は null です。

実装
public function get textBlock():flash.text.engine:TextBlock

関連する API エレメント

TextBlock

textBlockBeginIndex

プロパティ

textBlockBeginIndex:int [読み取り専用]

言語バージョン:

ActionScript 3.0

ランタイムバージョン:

Flash Player 10, AIR 1.5, Flash Lite 4

このエレメントの最初の文字のテキストブロック内のインデックスです。この値はキャッシュされません。このメソッドが呼び出されるたびに算出されます。

デフォルト値は -1 です。

実装
public function get textBlockBeginIndex():int

textRotation

プロパティ

textRotation:String

言語バージョン:

ActionScript 3.0

ランタイムバージョン:

Flash Player 10, AIR 1.5, Flash Lite 4

エレメントを単位として適用される回転です。このプロパティには、TextRotation 定数を使用します。

デフォルト値は、TextRotation.ROTATE_0 です。

任意の文字の最終的な回転は、ElementFormat.textRotation、ContentElement.textRotation および TextBlock.lineRotation の合計になります。

ContentElement.textRotation は、それを含む行とは回転が異なる短いテキストを作成するために使用されます。日本語テキスト内の TCY（縦中横）のテキスト範囲は、この一例です。TCY とは、縦、中、横を表しており、縦書きの日本語テキストの中で使用される小さな横書きのテキスト（通常は数字）です。TCY のテキスト範囲を含む、縦書きの日本語テキストの Paragraph を作成するには、次の処理を行います。

TextBlock.lineRotation=TextRotation.ROTATE_90 と設定します。
TextBlock.content を、3 つの TextElement オブジェクトで構成される GroupElement に設定します。これらのエレメントのうち、1 番目は TCY のテキスト範囲の前にある日本語テキスト、2 番目は TCY のラテン語のテキスト範囲、3 番目は TCY のテキスト範囲の後にある日本語テキストです。
TCY の TextElement の textRotation プロパティを 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):void

例外

	`ArgumentError` — TextRotation のメンバーではないいずれかの値に設定する場合。

	`ArgumentError` — `TextRotation.AUTO` に設定する場合。

	`ArgumentError` — 処理の結果、GroupElement 内で回転がネストする場合。

userData

プロパティ

public var userData:*

言語バージョン:

ActionScript 3.0

ランタイムバージョン:

Flash Player 10, AIR 1.5, Flash Lite 4

アプリケーションが任意のデータをエレメントに関連付けるための方法を提供します。

デフォルト値は null です。

コンストラクターの詳細

()

コンストラクター

public function ContentElement(elementFormat:ElementFormat = null, eventMirror:EventDispatcher = null, textRotation:String = "rotate0")

言語バージョン:

ActionScript 3.0

ランタイムバージョン:

Flash Player 10, AIR 1.5, Flash Lite 4

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, Flash Lite 4

テキスト内にグラフィックエレメントが存在するかどうかを示します。

関連する API エレメント

rawText

法律上の注意 | プライバシーポリシー

ContentElement - AS3

パッケージx

言語エレメント

付録

パッケージ flash.text.engine

elementFormat

eventMirror

groupElement

rawText

text

textBlock

textBlockBeginIndex

textRotation

userData

ContentElement

GRAPHIC_ELEMENT