Packagejp.nium.utils
Classpublic final class StageUtil

StageUtil クラスは、Stage 操作のためのユーティリティクラスです。 The StageUtil class is an utility class for stage operation.



Public Methods
 MethodDefined by
  
getDocument(stage:Stage):Sprite
[static] SWF ファイル書き出し時にドキュメントとして設定されたクラスを返します。 Returns the class that set as document when writing the SWF file.
StageUtil
  
getMarginLeft(stage:Stage):Number
[static] ステージの左マージンを取得します。 Get the left margin of the stage.
StageUtil
  
getMarginTop(stage:Stage):Number
[static] ステージの上マージンを取得します。 Get the top margin of the stage.
StageUtil
Method detail
getDocument()method
public static function getDocument(stage:Stage):Sprite

SWF ファイル書き出し時にドキュメントとして設定されたクラスを返します。 Returns the class that set as document when writing the SWF file.

Parameters
stage:Stageドキュメントを保存している stage インスタンスです。 The stage instance which save the document.

Returns
Spriteドキュメントとして設定された表示オブジェクトです。 The display object that set as document.

Example
   

getMarginLeft()method 
public static function getMarginLeft(stage:Stage):Number

ステージの左マージンを取得します。 Get the left margin of the stage.

Parameters
stage:Stageマージンを取得したい stage インスタンスです。 The stage instance to get the margin.

Returns
Number左マージンです。 The left margin.

Example
   

getMarginTop()method 
public static function getMarginTop(stage:Stage):Number

ステージの上マージンを取得します。 Get the top margin of the stage.

Parameters
stage:Stageマージンを取得したい stage インスタンスです。 The stage instance to get the margin.

Returns
Number上マージンです。 The top margin.

Example