Configuration

パッケージ	flashx.textLayout.elements
クラス	public class Configuration
継承	Configuration Object
実装	IConfiguration

言語バージョン:

ActionScript 3.0

ランタイムバージョン:

Flash Player 10, AIR 1.5

Configuration クラスは、Text Layout Framework とアプリケーション間の統合のプライマリーポイントです。TextFlow インスタンスの新規作成時、TextFlow() のコンストラクターに Configuration オブジェクトをパラメーターとして含めることができます。これにより、アプリケーションでは Text Layout Framework の動作方法を最初に制御できます。

Configuration クラスにより、textFlowInitialFormat プロパティを介してテキストフローの段落フォーマットおよびコンテナのフォーマットの初期値を指定できます。また、これにより、リンク、選択範囲、スクロールの初期フォーマット属性、および Tab キーと Enter キーを処理するための初期フォーマット属性を指定できます。

例を表示

さらに例を参照

Applying styles with the Configuration class

パブリックプロパティ

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

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

	プロパティ		定義元
		constructor : Object 指定されたオブジェクトインスタンスのクラスオブジェクトまたはコンストラクター関数への参照です。	Object
		defaultLinkActiveFormat : flashx.textLayout.formats:ITextLayoutFormat テキストフロー内のすべてのリンク（LinkElement オブジェクト）に対して初期設定で適用するアクティブな文字フォーマット属性を指定します。	Configuration
		defaultLinkHoverFormat : flashx.textLayout.formats:ITextLayoutFormat テキストフロー内のリンク（LinkElement）をカーソルがホバーしたときにに適用する文字フォーマット属性の初期値を指定します。	Configuration
		defaultLinkNormalFormat : flashx.textLayout.formats:ITextLayoutFormat テキストフロー内のすべての LinkElement オブジェクトのリンク属性の初期値を指定します。	Configuration
		defaultListMarkerFormat : IListMarkerFormat テキストフロー内のすべての ListItems に対して初期設定で適用するアクティブな文字フォーマット属性を指定します。	Configuration
		enableAccessibility : Boolean アクセシビリティのサポートを有効にするかどうかを指定します。	Configuration
		flowComposerClass : Class 新しい TextFlow オブジェクトにデフォルトで追加するフローコンポーザーのタイプを指定します。	Configuration
		focusedSelectionFormat : SelectionFormat テキストフローのウィンドウにフォーカスがある場合の、テキストフロー（TextFlow）の初期選択フォーマット（SelectionFormat）です。	Configuration
		inactiveSelectionFormat : SelectionFormat ウィンドウが非アクティブな場合の、テキストフロー（TextFlow）の初期選択フォーマット（SelectionFormat）です。	Configuration
		inlineGraphicResolverFunction : Function インライングラフィックエレメントの解決に使用するコールバックを指定します。	Configuration
		manageEnterKey : Boolean Text Layout Framework で Enter キーまたは Return キーをテキストとして入力して例えば段落を分けるか、またはクライアントコードで処理するかを指定します。	Configuration
		manageTabKey : Boolean Text Layout Framework で TAB キーをテキストとして入力するか、または Flash Player か AIR で処理してこれをタブ付きパネルイベントにするかを指定します。	Configuration
		overflowPolicy : String コンテナの最後の行をコンテナ内に収めるか、またはコンテナ外に出すかを決定するために使用されるポリシーです。	Configuration
		releaseLineCreationData : Boolean テキストの構成プロセスで、段落が構成されるたびに、行の作成データを解放することを要求します。	Configuration
		scrollDragDelay : Number スクロールが高速になり過ぎないよう、スクロールと次のスクロールの間に一定時間の遅延を指定します。	Configuration
		scrollDragPixels : Number ユーザーが選択範囲をドラッグして自動スクロールを開始した場合に、スクロールするデフォルトのピクセル数を指定します。	Configuration
		scrollMouseWheelMultiplier : Number マウスホイールイベントでスクロールする場合のデフォルトのピクセル数を指定します。	Configuration
		scrollPagePercentage : Number ページスクロールする場合のスクロールするテキストフローのデフォルトのパーセント値を指定します。	Configuration
		textFlowInitialFormat : flashx.textLayout.formats:ITextLayoutFormat テキストフロー（TextFlow オブジェクト）の初期フォーマット TextLayoutFormat の構成を指定します。	Configuration
		unfocusedSelectionFormat : SelectionFormat ウィンドウはアクティブだが TextFlow 内のいずれのコンテナにもフォーカスがない場合に、Text Layout Framework が選択範囲を表すために使用する初期選択フォーマットを設定します。	Configuration

パブリックメソッド

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

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

	メソッド		定義元
		Configuration(initializeWithDefaults:Boolean = true) コンストラクター - デフォルトの構成を作成します。	Configuration
		clone():Configuration Configuration オブジェクトのクローンを作成します。	Configuration
		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

プロパティの詳細

defaultLinkActiveFormat

プロパティ

defaultLinkActiveFormat:flashx.textLayout.formats:ITextLayoutFormat

言語バージョン:

ActionScript 3.0

ランタイムバージョン:

Flash Player 10, AIR 1.5

テキストフロー内のすべてのリンク（LinkElement オブジェクト）に対して初期設定で適用するアクティブな文字フォーマット属性を指定します。これらは、これらの属性値が指定されていない新規の LinkElement オブジェクトでデフォルト値になります。

デフォルト値は null です。

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

defaultLinkHoverFormat

プロパティ

defaultLinkHoverFormat:flashx.textLayout.formats:ITextLayoutFormat

言語バージョン:

ActionScript 3.0

ランタイムバージョン:

Flash Player 10, AIR 1.5

テキストフロー内のリンク（LinkElement）をカーソルがホバーしたときにに適用する文字フォーマット属性の初期値を指定します。これらは、これらの属性値が指定されていない新規の LinkElement オブジェクトでデフォルト値になります。

デフォルト値は null です。

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

defaultLinkNormalFormat

プロパティ

defaultLinkNormalFormat:flashx.textLayout.formats:ITextLayoutFormat

言語バージョン:

ActionScript 3.0

ランタイムバージョン:

Flash Player 10, AIR 1.5

テキストフロー内のすべての LinkElement オブジェクトのリンク属性の初期値を指定します。これらは、これらの属性値が指定されていない新規の LinkElement オブジェクトでデフォルト値になります。デフォルトの通常のフォーマットでは、青色のリンクが下線付きで表示されます。

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

defaultListMarkerFormat

プロパティ

defaultListMarkerFormat:IListMarkerFormat

言語バージョン:

ActionScript 3.0

ランタイムバージョン:

Flash Player 10, AIR 1.5

テキストフロー内のすべての ListItems に対して初期設定で適用するアクティブな文字フォーマット属性を指定します。これらは、これらの属性値が指定されていない新規の ListItemElements オブジェクトでデフォルト値になります。

デフォルト値は null です。

実装
public function get defaultListMarkerFormat():IListMarkerFormat
public function set defaultListMarkerFormat(value:IListMarkerFormat):void

enableAccessibility

プロパティ

enableAccessibility:Boolean

言語バージョン:

ActionScript 3.0

ランタイムバージョン:

Flash Player 10, AIR 1.5

アクセシビリティのサポートを有効にするかどうかを指定します。true の場合、スクリーンリーダーは、TextFlow コンテンツを読み取ることができます。

デフォルト値は false です。

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

関連する API エレメント

TextFlow

flowComposerClass

プロパティ

flowComposerClass:Class

言語バージョン:

ActionScript 3.0

ランタイムバージョン:

Flash Player 10, AIR 1.5

新しい TextFlow オブジェクトにデフォルトで追加するフローコンポーザーのタイプを指定します。デフォルト値は StandardFlowComposer です。

実装
public function get flowComposerClass():Class
public function set flowComposerClass(value:Class):void

関連する API エレメント

StandardFlowComposer
TextFlow

focusedSelectionFormat

プロパティ

focusedSelectionFormat:SelectionFormat

言語バージョン:

ActionScript 3.0

ランタイムバージョン:

Flash Player 10, AIR 1.5

テキストフローのウィンドウにフォーカスがある場合の、テキストフロー（TextFlow）の初期選択フォーマット（SelectionFormat）です。ウィンドウがアクティブで TextFlow 内のコンテナの 1 つにフォーカスがある場合、Text Layout Framework は focusedSelectionFormat を使用して選択対象を表します。必要に応じて、SelectionManager.focusedSelectionFormat を使用してこのフォーマットをオーバーライドできます。

SelectionFormat クラスは、デフォルト値を指定します。これは、テキストとその背景の色を反転させます。

実装
public function get focusedSelectionFormat():SelectionFormat
public function set focusedSelectionFormat(value:SelectionFormat):void

inactiveSelectionFormat

プロパティ

inactiveSelectionFormat:SelectionFormat

言語バージョン:

ActionScript 3.0

ランタイムバージョン:

Flash Player 10, AIR 1.5

ウィンドウが非アクティブな場合の、テキストフロー（TextFlow）の初期選択フォーマット（SelectionFormat）です。ウィンドウが非アクティブな場合、Text Layout Framework は inactiveSelectionFormat を使用して選択対象を表します。必要に応じて、SelectionManager.inactiveSelectionFormat を使用してこのフォーマットをオーバーライドできます。

unfocusedSelectionFormat をオーバーライドしない場合、次のような SelectionFormat 値が使用されます。

color = 0xffffff（白）
alpha = 0
blendMode = flash.display.BlendMode.DIFFERENCE

この結果として、選択範囲は表示されません。

実装
public function get inactiveSelectionFormat():SelectionFormat
public function set inactiveSelectionFormat(value:SelectionFormat):void

inlineGraphicResolverFunction

プロパティ

inlineGraphicResolverFunction:Function

言語バージョン:

ActionScript 3.0

ランタイムバージョン:

Flash Player 10, AIR 1.5

インライングラフィックエレメントの解決に使用するコールバックを指定します。コールバックは flashx.textLayout.elements.InlineGraphicElement オブジェクトを受け取り、エレメントの flashx.textLayout.elements.InlineGraphicElement#source として使用する値を返します。このコールバックにより、インライングラフィックエレメントのソースの提供を構成の直前まで遅延させるメカニズムを実現します。

注意：このコールバックは、String 型のプレースホルダーが既に設定されている場合のみ呼び出されます。また、複数回呼び出される可能性があります。

実装
public function get inlineGraphicResolverFunction():Function
public function set inlineGraphicResolverFunction(value:Function):void

関連する API エレメント

InlineGraphicElement

manageEnterKey

プロパティ

manageEnterKey:Boolean

言語バージョン:

ActionScript 3.0

ランタイムバージョン:

Flash Player 10, AIR 1.5

Text Layout Framework で Enter キーまたは Return キーをテキストとして入力して例えば段落を分けるか、またはクライアントコードで処理するかを指定します。クライアントコードでは、例えば、その目的用のデフォルトボタンを含むフォームをコミットしてこれを処理する場合があります。

デフォルト値は true です。

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

manageTabKey

プロパティ

manageTabKey:Boolean

言語バージョン:

ActionScript 3.0

ランタイムバージョン:

Flash Player 10, AIR 1.5

Text Layout Framework で TAB キーをテキストとして入力するか、または Flash Player か AIR で処理してこれをタブ付きパネルイベントにするかを指定します。

デフォルト値は false です。

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

overflowPolicy

プロパティ

overflowPolicy:String

言語バージョン:

ActionScript 3.0

ランタイムバージョン:

Flash Player 10, AIR 1.5

コンテナの最後の行をコンテナ内に収めるか、またはコンテナ外に出すかを決定するために使用されるポリシーです。OverflowPolicy クラスの定数を使用して、このプロパティを設定します。

デフォルト値は OverflowPolicy.FIT_DESCENDERS で、この値では、行の頂点からベースラインまでの領域が収まる場合、行は構成領域内に収められます。

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

関連する API エレメント

OverflowPolicy

releaseLineCreationData

プロパティ

releaseLineCreationData:Boolean

言語バージョン:

ActionScript 3.0

ランタイムバージョン:

Flash Player 10, AIR 1.5

テキストの構成プロセスで、段落が構成されるたびに、行の作成データを解放することを要求します。この要求によりメモリが節約されますが、構成プロセスは遅くなります。

デフォルト値は false です。

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

scrollDragDelay

プロパティ

scrollDragDelay:Number

言語バージョン:

ActionScript 3.0

ランタイムバージョン:

Flash Player 10, AIR 1.5

スクロールが高速になり過ぎないよう、スクロールと次のスクロールの間に一定時間の遅延を指定します。遅延は、この値によってミリ秒単位で指定します。デフォルト値は 35 です。

実装
public function get scrollDragDelay():Number
public function set scrollDragDelay(value:Number):void

scrollDragPixels

プロパティ

scrollDragPixels:Number

言語バージョン:

ActionScript 3.0

ランタイムバージョン:

Flash Player 10, AIR 1.5

ユーザーが選択範囲をドラッグして自動スクロールを開始した場合に、スクロールするデフォルトのピクセル数を指定します。デフォルト値は 20 です。

実装
public function get scrollDragPixels():Number
public function set scrollDragPixels(value:Number):void

scrollMouseWheelMultiplier

プロパティ

scrollMouseWheelMultiplier:Number

言語バージョン:

ActionScript 3.0

ランタイムバージョン:

Flash Player 10, AIR 1.5

マウスホイールイベントでスクロールする場合のデフォルトのピクセル数を指定します。デフォルト値は 20 です。

実装
public function get scrollMouseWheelMultiplier():Number
public function set scrollMouseWheelMultiplier(value:Number):void

scrollPagePercentage

プロパティ

scrollPagePercentage:Number

言語バージョン:

ActionScript 3.0

ランタイムバージョン:

Flash Player 10, AIR 1.5

ページスクロールする場合のスクロールするテキストフローのデフォルトのパーセント値を指定します。デフォルト値は、7.0 / 8.0 または .875 です。

実装
public function get scrollPagePercentage():Number
public function set scrollPagePercentage(value:Number):void

textFlowInitialFormat

プロパティ

textFlowInitialFormat:flashx.textLayout.formats:ITextLayoutFormat

言語バージョン:

ActionScript 3.0

ランタイムバージョン:

Flash Player 10, AIR 1.5

テキストフロー（TextFlow オブジェクト）の初期フォーマット TextLayoutFormat の構成を指定します。

デフォルト値は null です。

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

関連する API エレメント

TextFlow
ITextLayoutFormat

unfocusedSelectionFormat

プロパティ

unfocusedSelectionFormat:SelectionFormat

言語バージョン:

ActionScript 3.0

ランタイムバージョン:

Flash Player 10, AIR 1.5

ウィンドウはアクティブだが TextFlow 内のいずれのコンテナにもフォーカスがない場合に、Text Layout Framework が選択範囲を表すために使用する初期選択フォーマットを設定します。必要に応じて、SelectionManager.unfocusedSelectionFormat を使用してこのフォーマットをオーバーライドできます。

unfocusedSelectionFormat をオーバーライドしない場合、次のような SelectionFormat 値が使用されます。

color = 0xffffff（白）
alpha = 0
blendMode = flash.display.BlendMode.DIFFERENCE

この結果として、選択範囲は表示されません。

実装
public function get unfocusedSelectionFormat():SelectionFormat
public function set unfocusedSelectionFormat(value:SelectionFormat):void

コンストラクターの詳細

()

コンストラクター

public function Configuration(initializeWithDefaults:Boolean = true)

言語バージョン:

ActionScript 3.0

ランタイムバージョン:

Flash Player 10, AIR 1.5

コンストラクター - デフォルトの構成を作成します。

パラメーター

initializeWithDefaults:Boolean (default = true) — デフォルト値により構成を初期化するかどうかを指定します。デフォルト値は true です。false に設定すると、デフォルト値を使用せずに初期化し、したがっていくつかのオブジェクトが保存されます。clone() メソッドは、これを false に設定して元のオブジェクトからプロパティをコピーします。

関連する API エレメント

SelectionFormat
StandardFlowComposer

メソッドの詳細

clone

()

メソッド

public function clone():Configuration

言語バージョン:

ActionScript 3.0

ランタイムバージョン:

Flash Player 10, AIR 1.5

Configuration オブジェクトのクローンを作成します。

戻り値

Configuration

定数の詳細

hasTouchScreen

定数

tlf_internal static const hasTouchScreen:Boolean

例この例の使用方法

ConfigurationExample.as

この例では、段落とリンクから構成される TextFlow に適用される初期フォーマット構成を作成します。


package flashx.textLayout.elements.examples {
    import flash.display.Sprite;
    import flash.text.engine.FontPosture;
    import flash.text.engine.Kerning;
    
    import flashx.textLayout.container.ContainerController;
    import flashx.textLayout.edit.SelectionFormat;
    import flashx.textLayout.edit.SelectionManager;
    import flashx.textLayout.elements.Configuration;
    import flashx.textLayout.elements.LinkElement;
    import flashx.textLayout.elements.ParagraphElement;
    import flashx.textLayout.elements.SpanElement;
    import flashx.textLayout.elements.TextFlow;
    import flashx.textLayout.formats.TextAlign;
    import flashx.textLayout.formats.TextDecoration;
    import flashx.textLayout.formats.TextLayoutFormat;

    public class ConfigurationExample extends Sprite
    {
        public function ConfigurationExample()
        {    
            //create container for the text and add to stage
            var textContainer:Sprite = new Sprite();
            textContainer.x = 50;
            textContainer.y = 20;
            this.stage.addChild( textContainer );
            
            // create Configuration, set properties for it and add to TextFlow
            var config:Configuration = new Configuration();
            var textLayoutFormat:TextLayoutFormat = new TextLayoutFormat();
            textLayoutFormat.fontFamily = "Arial, Helvetica, _sans";
            textLayoutFormat.fontSize = 16;
            textLayoutFormat.kerning = Kerning.ON;
            textLayoutFormat.fontStyle = FontPosture.ITALIC;
            textLayoutFormat.textAlign = TextAlign.CENTER;
            config.textFlowInitialFormat = textLayoutFormat;
            var linkNormalFormat:TextLayoutFormat = new TextLayoutFormat();
            // make links red and underlined
            linkNormalFormat.color = 0xFF0000;
            linkNormalFormat.textDecoration = TextDecoration.UNDERLINE;
            config.defaultLinkNormalFormat = linkNormalFormat;
            // set selection color to light blue
              var selectionFormat:SelectionFormat = new SelectionFormat(0x333300);
              config.focusedSelectionFormat = selectionFormat;
            var textFlow:TextFlow = new TextFlow(config);
            // make text selectable
            var selectionManager:SelectionManager = new SelectionManager();
            textFlow.interactionManager = selectionManager;
            
            // create paragraph, a span of text, and a link
            var p:ParagraphElement = new ParagraphElement();
            var span:SpanElement = new SpanElement();
            var linkSpan:SpanElement = new SpanElement();
            var link:LinkElement = new LinkElement();
            link.href = "http://www.adobe.com";
            linkSpan.text = "Adobe's website";
            link.addChild(linkSpan);
            span.text = "The best place to go for information about Adobe products is: ";
            
            // Add span and link to paragraph; add paragraph to TextFlow
            p.addChild(span);
            p.addChild(link);
            textFlow.addChild(p);
            
            // Add a controller for the container; specify container width and height
            textFlow.flowComposer.addController(new ContainerController(textContainer, 80, 300));
            textFlow.flowComposer.updateAllControllers(); 
        }
    }
}

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

Configuration - AS3

クラス x

defaultLinkActiveFormat

defaultLinkHoverFormat

defaultLinkNormalFormat

defaultListMarkerFormat

enableAccessibility

flowComposerClass

focusedSelectionFormat

inactiveSelectionFormat

inlineGraphicResolverFunction

manageEnterKey

manageTabKey

overflowPolicy

releaseLineCreationData

scrollDragDelay

scrollDragPixels

scrollMouseWheelMultiplier

scrollPagePercentage

textFlowInitialFormat

unfocusedSelectionFormat

Configuration

clone

hasTouchScreen