mxsdoc

FlexGridLayout.ms

依存

struct FlexGridLayoutStruct

グリッドにアイテムを配置する。

補足

矩形の指定にBox2値を使用する都合上、各セルの幅と高さの最小値は1となる。

通知
通知名 通知データ タイミング
#ColumnFixedLength 新たな列の固定幅 列の固定幅を設定した後
#ColumnMinimumWidth 新たな列の最小幅 列の最小幅を設定した後
#ColumnStretch 新たな列のストレッチ係数 列のストレッチ係数を設定した後
#LayoutAdded 追加したセル レイアウトを追加した後
#RectUpdated 各セルの矩形 レイアウトの矩形を設定した後
#RowFixedLength 新たな行の固定高 行の固定高を設定した後
#RowMinimumHeight 新たな行の最小高 行の最小高を設定した後
#RowStretch 新たな行のストレッチ係数 行のストレッチ係数を設定した後
#VisibilityChanged 新たなセルのアイテムの可視性 セルのアイテムの可視性を設定した後
#WidgetAdded 追加したセル ウィジェットを追加した後

public Options

プロパティ
<Struct:FlexLayoutOptionsStruct>

既定値はundefined。未指定の場合は既定値で作成される。

private cells

プロパティ
<Array[<Struct:FlexGridCellStruct>]>

セルのアイテム。既定値は#()

private columnCells

プロパティ
<Array[<Struct:FlexBoxCellStruct>]>

列を構成するセル。既定値は#()

private rowCells

プロパティ
<Array[<Struct:FlexBoxCellStruct>]>

行を構成するセル。既定値は#()

private boxCellDef

プロパティ
<StructDef:FlexBoxCellStruct>

private gridCellDef

プロパティ
<StructDef:FlexGridCellStruct>

public fn AddLayout

レイアウトを追加する。

パラメータ
layout
<Struct>
パラメータ
row
<Integer>

セルを配置する行。1以上の整数。

パラメータ
column
<Integer>

セルを配置する列。1以上の整数。

パラメータ
rowSpan:
<Integer>

セルが専有する行数。1以上の整数。既定値は1

パラメータ
columnSpan:
<Integer>

セルが専有する列数。1以上の整数。既定値は1

戻り値
<Struct:FlexGridCellStruct|UndefinedClass>
補足

無効な値の場合はundefinedを返す。

public fn AddWidget

ウィジェットを追加する。

パラメータ
widget
<Struct>
パラメータ
row
<Integer>

セルを配置する行。1以上の整数。

パラメータ
column
<Integer>

セルを配置する列。1以上の整数。

パラメータ
rowSpan:
<Integer>

セルが専有する行数。1以上の整数。既定値は1

パラメータ
columnSpan:
<Integer>

セルが専有する列数。1以上の整数。既定値は1

戻り値
<Struct:FlexGridCellStruct|UndefinedClass>
補足

無効な値の場合はundefinedを返す。

public fn GetCells

セルのアイテムを取得する。

戻り値
<Array[<Struct:FlexGridCellStruct>]>

public fn GetColumnCells

列を構成するセルを取得する。

戻り値
<Array[<Struct:FlexBoxCellStruct>]>

public fn GetRowCells

行を構成するセルを取得する。

戻り値
<Array[<Struct:FlexBoxCellStruct>]>

public fn GetVisibility

セルのアイテムの可視性を取得する。

戻り値
<BooleanClass|UndefinedClass>
補足

値を取得できない場合や真偽混合の場合はundefinedを返す。

public fn SetColumnFixedLength

列の固定幅を設定する。

パラメータ
column
<Integer>

対象の列。1以上の整数。

パラメータ
fixedLength
<Integer|UndefinedClass>

固定幅。1以上の整数、またはundefined

戻り値
<Integer|UndefinedClass>
補足

無効な値の場合は何もしない。

public fn SetColumnMinimumWidth

列の最小幅を設定する。

パラメータ
column
<Integer>

対象の列。1以上の整数。

パラメータ
minimum
<Integer>

最小幅。1以上の整数。

戻り値
<Integer|UndefinedClass>
補足

無効な値の場合は何もしない。

public fn SetColumnStretch

列のストレッチ係数を設定する。

パラメータ
column
<Integer>

対象の列。1以上の整数。

パラメータ
stretch
<Integer>

ストレッチ係数。1以上の整数。

戻り値
<Integer|UndefinedClass>
補足

無効な値の場合は何もしない。

public fn SetRect

レイアウトの矩形を設定する。

パラメータ
rect
<Box2>
戻り値
<Array[<Box2>]>

public fn SetRowFixedLength

行の固定高を設定する。

パラメータ
row
<Integer>

対象の列。1以上の整数。

パラメータ
minimum
<Integer>

固定高。1以上の整数。

戻り値
<Integer|UndefinedClass>
補足

無効な値の場合は何もしない。

public fn SetRowMinimumHeight

行の最小高を設定する。

パラメータ
row
<Integer>

対象の列。1以上の整数。

パラメータ
minimum
<Integer>

最小高。1以上の整数。

戻り値
<Integer|UndefinedClass>
補足

無効な値の場合は何もしない。

public fn SetRowStretch

行のストレッチ係数を設定する。

パラメータ
row
<Integer>

対象の行。1以上の整数。

パラメータ
stretch
<Integer>

ストレッチ係数。1以上の整数。

戻り値
<Integer|UndefinedClass>
補足

無効な値の場合は何もしない。

public fn SetVisibility

セルのアイテムの可視性を設定する。

パラメータ
input
<BooleanClass>
戻り値
<BooleanClass|UndefinedClass>
補足

無効な値の場合は何もしない。

private fn addGrid

グリッドを構成するセルを追加する。

パラメータ
row
<Integer>

開始行。1以上の整数。

パラメータ
column
<Integer>

開始列。1以上の整数。

パラメータ
rowSpan
<Integer>

行の数。1以上の整数。

パラメータ
columnSpan
<Integer>

列の数。1以上の整数。

戻り値
<BooleanClass>

指定した範囲のセルが全て存在する場合はtrue、一つでも存在しない場合はfalse

private fn findWidget

パラメータ
widget
<Struct>
戻り値
<Integer>

private fn generateColumnRects

列の矩形を生成する。

パラメータ
rect
<Box2>
戻り値
<Array[<Box2>]>

private fn generateRowRects

行の矩形を生成する。

パラメータ
rect
<Box2>
戻り値
<Array[<Box2>]>

private fn isMatchStructName

構造体名が指定したパターンに一致するかどうかを判定する。

パラメータ
obj
<Any>
パラメータ
pattern
<String>
戻り値
<BooleanClass>

private fn isValidLayoutOptions

パラメータ
obj
<Any>
戻り値
<BooleanClass>

private fn isValidStretchCell

パラメータ
obj
<Any>
戻り値
<BooleanClass>

private fn isValidWidget

パラメータ
obj
<Any>
戻り値
<BooleanClass>

public fn StructName

戻り値
<Name>

public fn Dump

パラメータ
indent:
<String>
パラメータ
out:
<FileStream|StringStream|WindowStream>

出力先。既定値はlistener

戻り値
<OkClass>

public fn Equals

パラメータ
obj
<Any>
戻り値
<BooleanClass>
補足

大文字と小文字を区別する。

public StateChanged

プロパティ
<Struct:ObservableStruct>