StringTextLineFactory

パッケージ	flashx.textLayout.factory
クラス	public class StringTextLineFactory
継承	StringTextLineFactory TextLineFactoryBase Object

言語バージョン:

ActionScript 3.0

ランタイムバージョン:

Flash Player 10, AIR 1.5

StringTextLineFactory クラスは、文字列から TextLine を作成するための簡単な方法を提供します。

テキスト行は静的で、単一のフォーマットと単一の段落により作成されます。行は、指定した矩形の枠に収まるよう作成されます。

StringTextLineFactory は、何度も繰り返される呼び出しに、単一の TextFlow、ParagraphElement、SpanElement および ContainerController オブジェクトを再使用するため、TextLine を作成するための効果的な方法となっています。単一のファクトリを作成して、それを繰り返し利用できます。また、呼び出すたびに同じである部分はすべて、再使用できます。例えば、様々なフォーマットや境界を再使用できます。

注意：複数のフォーマットや段落を使用するかまたはインライングラフィックを含む静的な行を作成するには、TextFlowTextLineFactory および TextFlow オブジェクトを使用します。

注意：StringTextLineFactory は、テキストを切り詰めるときに、truncationOptions で設定された truncationIndicatorFormat プロパティを無視します。

例を表示

関連する API エレメント

TextFlowTextLineFactory

パブリックプロパティ

継承されるパブリックプロパティを隠す

継承されるパブリックプロパティを表示

	プロパティ		定義元
		compositionBounds : Rectangle その中にテキスト行が作成される矩形です。	TextLineFactoryBase
		configuration : IConfiguration [読み取り専用] 内部 TextFlow オブジェクトで使用される構成です。	StringTextLineFactory
		constructor : Object 指定されたオブジェクトインスタンスのクラスオブジェクトまたはコンストラクター関数への参照です。	Object
		defaultConfiguration : IConfiguration [静的] [読み取り専用] 何も指定しない場合にこのファクトリにより使用されるデフォルトの構成です。	StringTextLineFactory
		horizontalScrollPolicy : String 入力境界が十分に大きくないときの行の作成方法を指定します。	TextLineFactoryBase
		isTruncated : Boolean [読み取り専用] 行を最後に作成したときにテキストが切り詰められたかどうかを示します。	TextLineFactoryBase
		paragraphFormat : flashx.textLayout.formats:ITextLayoutFormat 段落のフォーマットです。	StringTextLineFactory
		spanFormat : flashx.textLayout.formats:ITextLayoutFormat 文字のフォーマットです。	StringTextLineFactory
		swfContext : ISWFContext 必要に応じて FTE 呼び出しを行うために使用される ISWFContext インスタンスです。	TextLineFactoryBase
		text : String TextLine オブジェクトに変換するテキストです。	StringTextLineFactory
		textFlowFormat : flashx.textLayout.formats:ITextLayoutFormat テキストフローのフォーマットです。	StringTextLineFactory
		truncationOptions : flashx.textLayout.factory:TruncationOptions テキストが入力境界に収まらない場合に、テキストを切り詰めるオプションを指定します。	TextLineFactoryBase
		verticalScrollPolicy : String 入力境界が十分に大きくないときの行の作成方法を指定します。	TextLineFactoryBase

パブリックメソッド

継承されるパブリックメソッドを隠す

継承されるパブリックメソッドを表示

	メソッド		定義元
		StringTextLineFactory(configuration:IConfiguration = null) StringTextLineFactory オブジェクトを作成します。	StringTextLineFactory
		createTextLines(callback:Function):void 現在このファクトリオブジェクトに割り当てられているテキストを使用して TextLine オブジェクトを作成します。	StringTextLineFactory
		getContentBounds():Rectangle レイアウトされたコンテンツが収められる最小の矩形です。	TextLineFactoryBase
		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

プロパティの詳細

configuration

プロパティ

configuration:IConfiguration [読み取り専用]

言語バージョン:

ActionScript 3.0

ランタイムバージョン:

Flash Player 10, AIR 1.5

内部 TextFlow オブジェクトで使用される構成です。

実装
public function get configuration():IConfiguration

defaultConfiguration

プロパティ

defaultConfiguration:IConfiguration [読み取り専用]

言語バージョン:

ActionScript 3.0

ランタイムバージョン:

Flash Player 10, AIR 1.5

何も指定しない場合にこのファクトリにより使用されるデフォルトの構成です。

実装
public static function get defaultConfiguration():IConfiguration

paragraphFormat

プロパティ

paragraphFormat:flashx.textLayout.formats:ITextLayoutFormat

言語バージョン:

ActionScript 3.0

ランタイムバージョン:

Flash Player 10, AIR 1.5

段落のフォーマットです。

実装
public function get paragraphFormat():flashx.textLayout.formats:ITextLayoutFormat
public function set paragraphFormat(value:flashx.textLayout.formats:ITextLayoutFormat):void

spanFormat

プロパティ

spanFormat:flashx.textLayout.formats:ITextLayoutFormat

言語バージョン:

ActionScript 3.0

ランタイムバージョン:

Flash Player 10, AIR 1.5

文字のフォーマットです。

実装
public function get spanFormat():flashx.textLayout.formats:ITextLayoutFormat
public function set spanFormat(value:flashx.textLayout.formats:ITextLayoutFormat):void

text

プロパティ

text:String

言語バージョン:

ActionScript 3.0

ランタイムバージョン:

Flash Player 10, AIR 1.5

TextLine オブジェクトに変換するテキストです。

TextLine を作成するには、この text プロパティと必要なフォーマットを設定した後に、createTextLines() を呼び出します。

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

textFlowFormat

プロパティ

textFlowFormat:flashx.textLayout.formats:ITextLayoutFormat

言語バージョン:

ActionScript 3.0

ランタイムバージョン:

Flash Player 10, AIR 1.5

テキストフローのフォーマットです。

実装
public function get textFlowFormat():flashx.textLayout.formats:ITextLayoutFormat
public function set textFlowFormat(value:flashx.textLayout.formats:ITextLayoutFormat):void

コンストラクターの詳細

()

コンストラクター

public function StringTextLineFactory(configuration:IConfiguration = null)

言語バージョン:

ActionScript 3.0

ランタイムバージョン:

Flash Player 10, AIR 1.5

StringTextLineFactory オブジェクトを作成します。

パラメーター

configuration:IConfiguration (default = null) — このファクトリにより作成される行の構成に使用される内部 TextFlow オブジェクトのプロパティを設定するために使用される構成オブジェクトです。

メソッドの詳細

createTextLines

()

メソッド

public function createTextLines(callback:Function):void

言語バージョン:

ActionScript 3.0

ランタイムバージョン:

Flash Player 10, AIR 1.5

現在このファクトリオブジェクトに割り当てられているテキストを使用して TextLine オブジェクトを作成します。

テキスト行は、現在割り当てられているテキストおよびフォーマットを使用して作成され、compositionBounds プロパティに割り当てられた領域に収まるよう構成されます。行が作成されるたびに、callback パラメーターで指定されている関数がファクトリにより呼び出されます。この関数は TextLine オブジェクトに渡されて、行を表示する役割を担います。

他の一連の行を作成するには、任意にプロパティを変更して、createTextLines() を再度呼び出します。

ファクトリのスクロールポリシーは、生成される行数を制御することに注意してください。

パラメーター

callback:Function — 作成済みの各 TextLine オブジェクトに対して呼び出されるコールバック関数です。

例この例の使用方法

StringTextLineFactory_example.as

次の例では、文字列から一連のテキスト行を作成するために、StringTextLineFactory を使用しています。ファクトリメソッドの createTextLines() は、同じ句を使用して 2 回呼び出されています。ドロップシャドウ効果を作成するために、ファクトリのプロパティが呼び出しと呼び出しの間に調整されています。

package flashx.textLayout.factory.examples {
    import flash.display.DisplayObject;
    import flash.display.Sprite;
    import flash.geom.Rectangle;
    
    import flashx.textLayout.factory.StringTextLineFactory;
    import flashx.textLayout.formats.TextLayoutFormat;

    public class StringTextLineFactory_example extends Sprite
    {
        public function StringTextLineFactory_example()
        {
            var factory:StringTextLineFactory = new StringTextLineFactory();
            factory.compositionBounds = new Rectangle( 100, 100, 200, 130 );
            var format:TextLayoutFormat = new TextLayoutFormat();
            format.fontFamily = "LilyUPC, Verdana, _sans";
            format.fontSize = 32;
            format.color = 0x000000;
            format.textAlpha = .5;
            factory.spanFormat = format;
            
            factory.text = "The quick brown fox jumped over the lazy dog.";
            factory.createTextLines( useTextLines );
            
            factory.compositionBounds = new Rectangle( 99, 99, 200, 130 );
            format.color = 0x990000;
            format.textAlpha = 1;
            factory.spanFormat = format;
            factory.createTextLines( useTextLines );
            
            graphics.beginFill(0x555555,.5);
            graphics.drawRect( 99, 99, 201, 131 );
            graphics.endFill();

        }
        
        private function useTextLines( line:DisplayObject ):void
        {
            var displayObject:DisplayObject = this.addChild( line );
        }
    }
}

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

StringTextLineFactory - AS3

クラス x

configuration

defaultConfiguration

paragraphFormat

spanFormat

text

textFlowFormat

StringTextLineFactory

createTextLines