ASP.NET MVC コントロールヘルプ
FlowLayout Class
ファイル
c1.nav.js
モジュール
c1.nav.flow
基本クラス
LayoutBase
Show
   

Defines a class represents the flow layout.

コンストラクタ

プロパティ

メソッド

コンストラクタ

constructor

constructor(options?: any): FlowLayout

Initializes a new instance of the FlowLayout class.

パラメーター
戻り値
FlowLayout

プロパティ

activeTile

Gets the current active tile.

継承元
LayoutBase
Tile

dashboard

Gets the DashboardLayout control which the layout is applied in.

継承元
LayoutBase
DashboardLayout

definition

Gets or sets the current layout settings as a JSON string.

This property is typically used to persist the layout settings. The maximum state of the tile is temporary and it will not be persisted.

継承元
LayoutBase
any

direction

Gets or sets the direction the tiles renders in.

FlowDirection

fullTypeName

Gets the full type name of the current object.

string

isCreateGroup

Gets the isCreateGroup of the current object.

boolean

items

Gets the layout item collection.

継承元
LayoutBase
LayoutItemCollection

メソッド

addEventListener

addEventListener(target: EventTarget, type: string, fn: any, capture?: boolean): void

このControl が所有する要素にイベントリスナーを追加します。

コントロールは、アタッチされているリスナーとそのハンドラのリストを保持し、コントロールが破棄されているときにそれらを簡単に削除すること ができます(disposeremoveEventListener メソッドを参照してください)。

イベントリスナーを削除しないと、メモリリークが発生する可能があります。

パラメーター
  • target: EventTarget

    Target element for the event.

  • type: string

    String that specifies the event.

  • fn: any

    Function to execute when the event occurs.

  • capture: boolean Optional

    Whether the listener is capturing.

継承元
DisposableObject
戻り値
void

attachTo

attachTo(dashboard: DashboardLayout): void

Applies this layout to the specified DashboardLayout control.

パラメーター
継承元
LayoutBase
戻り値
void

detach

detach(): void

Detaches this layout from the DashboardLayout control.

It is often used when applying the new layout, the old layout should be detached.

戻り値
void

dispose

dispose(fullDispose?: boolean): void

オブジェクトを破棄します。

パラメーター
  • fullDispose: boolean Optional

    A boolean value decides wehter to keep the current status when disposing. If true, all the current status will be cleared. Otherwise, keep the current status.

戻り値
void

draw

draw(): void

Draws the layout.

戻り値
void

endMove

endMove(movedTile: Tile, endPosition: Point): void

Ends moving the tile at the specified postion.

パラメーター
  • movedTile: Tile

    The tile to be moved.

  • endPosition: Point

    The position where the tile is moved to. It is the coordinate within the browser visible area.

戻り値
void

initialize

initialize(options: any): void

Initializes the layout by copying the properties from a given object.

This method allows you to initialize the object using plain data objects instead of setting the value of each property in code.

パラメーター
  • options: any

    Object that contains the initialization data.

継承元
LayoutBase
戻り値
void

invalidate

invalidate(fullUpdate?: boolean): void

Invalidates the dashboard causing an asynchronous refresh.

パラメーター
  • fullUpdate: boolean Optional

    Whether to update the dashboard layout as well as the content.

継承元
LayoutBase
戻り値
void

move

move(movedTile: Tile, position: Point): void

Moves the tile.

パラメーター
  • movedTile: Tile

    The tile to be moved.

  • position: Point

    The position of the moving mouse. It is the coordinate within the browser visible area.

継承元
LayoutBase
戻り値
void

moveTo

moveTo(tile: Tile, pt: Point): void

Moves the tile to the specified postion.

パラメーター
  • tile: Tile

    The tile to be moved.

  • pt: Point

    The position where the tile is moved to in relation to the dashboard.

戻り値
void

refresh

refresh(fullUpdate?: boolean): void

Refreshes the layout.

パラメーター
  • fullUpdate: boolean Optional

    A boolean value decides whether to update the content completely. If true, the layout refreshes without keeping the current status(moving, resizing and etc.). Otherwise, the status is kept after refreshing.

継承元
LayoutBase
戻り値
void

remove

remove(removedTile: Tile): boolean

Removes the tile from the layout.

パラメーター
  • removedTile: Tile

    The tile to be removed.

継承元
LayoutBase
戻り値
boolean

removeEventListener

removeEventListener(target?: EventTarget, type?: string, fn?: any, capture?: boolean): number

このControl が所有する要素にアタッチされている1つまたは複数のイベントリスナーを解除します。

パラメーター
  • target: EventTarget Optional

    Target element for the event. If null, removes listeners attached to all targets.

  • type: string Optional

    String that specifies the event. If null, removes listeners attached to all events.

  • fn: any Optional

    Handler to remove. If null, removes all handlers.

  • capture: boolean Optional

    Whether the listener is capturing. If null, removes capturing and non-capturing listeners.

継承元
DisposableObject
戻り値
number

resize

resize(resizedTile: Tile, toPosition?: Point): boolean

Resize the tile to the specified postion.

パラメーター
  • resizedTile: Tile

    The tile to be resized.

  • toPosition: Point Optional

    The position where the tile is resized to. It is the coordinate within the browser visible area.

継承元
LayoutBase
戻り値
boolean

resizeTo

resizeTo(resizedTile: Tile, newSize: Size): boolean

Resizes the tile to the specified size.

Adds the codes to resize the tile to the specified size by pxWidth and pxHeight.

パラメーター
  • resizedTile: Tile

    The tile to be resized.

  • newSize: Size

    The new size.

戻り値
boolean

showAll

showAll(): void

すべてのタイルを表示します。

継承元
LayoutBase
戻り値
void

startMove

startMove(movedTile: Tile, startPosition: Point): boolean

タイルの移動を開始します。

パラメーター
  • movedTile: Tile

    The tile to be moved.

  • startPosition: Point

    The started position where the tile will be moved from. It is the coordinate within the browser visible area.

戻り値
boolean

toggleSize

toggleSize(currentTile: Tile): void

Toggles the tile size.

パラメーター
  • currentTile: Tile

    The tile to be toggled.

継承元
LayoutBase
戻り値
void