Packagejp.naggg.data
Classpublic class StageSize
InheritanceStageSize Inheritance Object

SWF のステージサイズ情報を扱いやすくしたクラスです. ただし、対応しているステージ配置はデフォルトの上下左右の中央のみになります. 基準となる幅と高さ、ステージ幅・高さ、四隅の座標などの各種情報を計算し、 ステージリサイズ時に、getInfo() メソッドより取得することができます. また、基準となる幅と高さは fla ファイルのステージ幅・高さを指定しますが、 このサイズを最小サイズとして認識し計算を行います. なお、Flashの仕様では、ステージサイズが奇数&表示領域が偶数、 すなわち左右のマージンの合計が偶数とならない場合、左右ともに四捨五入した値となるようです. たとえば、最小幅:800px、ステージ幅:815px の例では、 左マージン 7px、右マージン 8px として描画されます. getInfo() の第二引数で計算結果を四捨五入するかどうかを指定でき、 デフォルトでは true としています. また、デフォルトのステージアラインで基準点が中央となる表示オブジェクトの場合、 ステージ領域に拡大すると1pxのズれが生じる場合があります. 調査の結果、これはFlashの仕様のようで、偶数に切上された値を用いてください. stageEvenWidth および stageEvenHeight プロパティです.

View the examples



Public Properties
 PropertyDefined By
  bottom : Number
[read-only] 画面の下端y座標.getInfo() メソッドで取得した瞬間の値なので、更新する際には再度 getInfo() を用います.
StageSize
  bottomLeft : Point
[read-only] 画面左下座標.getInfo() メソッドで取得した瞬間の値なので、更新する際には再度 getInfo() を用います.
StageSize
  bottomRight : Point
[read-only] 画面左下座標.getInfo() メソッドで取得した瞬間の値なので、更新する際には再度 getInfo() を用います.
StageSize
  coordinate : String
[read-only] 座標基準となる DisplayObject の名前.getInfo() で指定がなかった場合、"global" となります.
StageSize
  defaultHeight : int
[read-only] ルートの規格高さ(flaファイルで設定した高さ).
StageSize
  defaultWidth : int
[read-only] ルートの規格幅(flaファイルで設定した幅).
StageSize
  left : Number
[read-only] 画面の左端x座標.getInfo() メソッドで取得した瞬間の値なので、更新する際には再度 getInfo() を用います.
StageSize
  right : Number
[read-only] 画面の右端x座標.getInfo() メソッドで取得した瞬間の値なので、更新する際には再度 getInfo() を用います.
StageSize
  stageEvenHeight : int
[read-only] 偶数に切上されたステージ高さ.基準点が中央にある表示オブジェクトの拡大するときに便利です.getInfo() メソッドで取得した瞬間の値なので、更新する際には再度 getInfo() を用います.
StageSize
  stageEvenWidth : int
[read-only] 偶数に切上されたステージ幅.基準点が中央にある表示オブジェクトの拡大するときに便利です.getInfo() メソッドで取得した瞬間の値なので、更新する際には再度 getInfo() を用います.
StageSize
  stageHeight : int
[read-only] ステージ高さ.getInfo() メソッドで取得した瞬間の値なので、更新する際には再度 getInfo() を用います.
StageSize
  stageWidth : int
[read-only] ステージ幅.getInfo() メソッドで取得した瞬間の値なので、更新する際には再度 getInfo() を用います.
StageSize
  top : Number
[read-only] 画面の上端y座標.getInfo() メソッドで取得した瞬間の値なので、更新する際には再度 getInfo() を用います.
StageSize
  topLeft : Point
[read-only] 画面左上座標.getInfo() メソッドで取得した瞬間の値なので、更新する際には再度 getInfo() を用います.
StageSize
  topRight : Point
[read-only] 画面右上座標.getInfo() メソッドで取得した瞬間の値なので、更新する際には再度 getInfo() を用います.
StageSize
Public Methods
 MethodDefined By
  
StageSize(internalCalled:InternalCallEnforcer = null)
コンストラクタを直接呼び出すことはできません..必ずエラーを返します.
StageSize
  
同じプロパティを持つインスタンスを返します.
StageSize
  
getInfo(coordinate:DisplayObject = null, round:Boolean = true):StageSize
[static] インスタンスの取得
StageSize
  
init(stage:Stage, defaultWidth:uint, defaultHeight:uint):void
[static] クラスの初期化を行います.
StageSize
  
toString():String
各プロパティを文字列で返します.
StageSize
Property Detail
bottomproperty
bottom:Number  [read-only]

画面の下端y座標.getInfo() メソッドで取得した瞬間の値なので、更新する際には再度 getInfo() を用います.


Implementation
    public function get bottom():Number
bottomLeftproperty 
bottomLeft:Point  [read-only]

画面左下座標.getInfo() メソッドで取得した瞬間の値なので、更新する際には再度 getInfo() を用います.


Implementation
    public function get bottomLeft():Point
bottomRightproperty 
bottomRight:Point  [read-only]

画面左下座標.getInfo() メソッドで取得した瞬間の値なので、更新する際には再度 getInfo() を用います.


Implementation
    public function get bottomRight():Point
coordinateproperty 
coordinate:String  [read-only]

座標基準となる DisplayObject の名前.getInfo() で指定がなかった場合、"global" となります.


Implementation
    public function get coordinate():String
defaultHeightproperty 
defaultHeight:int  [read-only]

ルートの規格高さ(flaファイルで設定した高さ).


Implementation
    public function get defaultHeight():int
defaultWidthproperty 
defaultWidth:int  [read-only]

ルートの規格幅(flaファイルで設定した幅).


Implementation
    public function get defaultWidth():int
leftproperty 
left:Number  [read-only]

画面の左端x座標.getInfo() メソッドで取得した瞬間の値なので、更新する際には再度 getInfo() を用います.


Implementation
    public function get left():Number
rightproperty 
right:Number  [read-only]

画面の右端x座標.getInfo() メソッドで取得した瞬間の値なので、更新する際には再度 getInfo() を用います.


Implementation
    public function get right():Number
stageEvenHeightproperty 
stageEvenHeight:int  [read-only]

偶数に切上されたステージ高さ.基準点が中央にある表示オブジェクトの拡大するときに便利です.getInfo() メソッドで取得した瞬間の値なので、更新する際には再度 getInfo() を用います.


Implementation
    public function get stageEvenHeight():int
stageEvenWidthproperty 
stageEvenWidth:int  [read-only]

偶数に切上されたステージ幅.基準点が中央にある表示オブジェクトの拡大するときに便利です.getInfo() メソッドで取得した瞬間の値なので、更新する際には再度 getInfo() を用います.


Implementation
    public function get stageEvenWidth():int
stageHeightproperty 
stageHeight:int  [read-only]

ステージ高さ.getInfo() メソッドで取得した瞬間の値なので、更新する際には再度 getInfo() を用います.


Implementation
    public function get stageHeight():int
stageWidthproperty 
stageWidth:int  [read-only]

ステージ幅.getInfo() メソッドで取得した瞬間の値なので、更新する際には再度 getInfo() を用います.


Implementation
    public function get stageWidth():int
topproperty 
top:Number  [read-only]

画面の上端y座標.getInfo() メソッドで取得した瞬間の値なので、更新する際には再度 getInfo() を用います.


Implementation
    public function get top():Number
topLeftproperty 
topLeft:Point  [read-only]

画面左上座標.getInfo() メソッドで取得した瞬間の値なので、更新する際には再度 getInfo() を用います.


Implementation
    public function get topLeft():Point
topRightproperty 
topRight:Point  [read-only]

画面右上座標.getInfo() メソッドで取得した瞬間の値なので、更新する際には再度 getInfo() を用います.


Implementation
    public function get topRight():Point
Constructor Detail
StageSize()Constructor
public function StageSize(internalCalled:InternalCallEnforcer = null)

コンストラクタを直接呼び出すことはできません..必ずエラーを返します.

Parameters
internalCalled:InternalCallEnforcer (default = null)

Throws
Error — #2012: StageSize クラスを直接インスタンス化することはできません。
Method Detail
clone()method
public function clone():StageSize

同じプロパティを持つインスタンスを返します.

Returns
StageSize — 同じプロパティを持つインスタンス.
getInfo()method 
public static function getInfo(coordinate:DisplayObject = null, round:Boolean = true):StageSize

インスタンスの取得

Parameters

coordinate:DisplayObject (default = null) — ステージ情報を欲しい座標系、nullが指定された場合 stage のグローバル座標となります.
 
round:Boolean (default = true) — グローバル座標系での各値(left, right, top, bottom)を四捨五入により整数化するかを指定します. グローバル座標は整数となりますが、coordinate で指定したオブジェクトの座標が整数でない場合、整数を返しません.

Returns
StageSize — 引数で指定された座標系からみた StageSize インスタンス
init()method 
public static function init(stage:Stage, defaultWidth:uint, defaultHeight:uint):void

クラスの初期化を行います.

Parameters

stage:Stage — ステージの参照です.
 
defaultWidth:uint — 基準となる幅、fla ファイルオーサリングの幅を指定します.この値は最小サイズとして認識されます.
 
defaultHeight:uint — 基準となる高さ、fla ファイルオーサリングの高さを指定します.この値は最小サイズとして認識されます.

toString()method 
public function toString():String

各プロパティを文字列で返します.

Returns
String
Examples
 
     import jp.naggg.data.StageSize;
     StageSize.init(800, 500);
     stage.addEventListener(Event.RESIZE, stageResizeHandler);
     function stageResizeHandler(evt:Event):void{
         // 子要素の座標
         var size1:StageSize = StageSize.getInfo(this, true);
         footer_mc.y = size1.bottom - footer_mc.height;
         // 子要素内部、座標系を指定する
         var size2:StageSize = StageSize.getInfo(footer_mc, true);
         footer_mc.bg_mc.width = size2.stageWidth;
         footer_mc.bg_mc.x = size2.left;
         footer_mc.menuLeft_mc.x = size2.left + 8;
         footer_mc.menuRight_mc.x = size2.right - footer_mc.menuRight_mc.width - 8;
         // 基準点が中央にある背景要素
         bg.width = size1.stageWidth; // 奇数の場合、右端に1pxの隙間
         bg.height = size1.stageHeight; // 奇数の場合、下端に1pxの隙間
         bg.width = size1.stageWidth + size1.stageWidth%2; // 自前で偶数切上
         bg.height = size1.stageHeight + size1.stageHeight%2; // 自前で偶数切上
         bg.width = size1.stageEvenWidth;
         bg.height = size1.stageEvenHeight;
     }