Options
All
  • Public
  • Public/Protected
  • All
Menu

Class Layout

A layout definition, including local and remote frame definitions.

Hierarchy

  • Layout

Index

Constructors

Properties

Methods

Constructors

constructor

  • Returns Layout

Properties

Private __localFrame

__localFrame: LayoutFrame
internal

Private __remoteFrames

__remoteFrames: LayoutFrame[]
internal

Private _height

_height: number
internal

Private _origin

_origin: LayoutOrigin
internal

Private _width

_width: number
internal

Methods

getAllFrames

  • getAllFrames(): LayoutFrame[]
  • Gets all frames (local and remote).

    Returns LayoutFrame[]

getHeight

  • getHeight(): number
  • Gets the layout height.

    Returns number

getLocalFrame

  • getLocalFrame(): LayoutFrame
  • Gets the local frame.

    Returns LayoutFrame

getOrigin

  • getOrigin(): LayoutOrigin
  • Gets the layout origin.

    Returns LayoutOrigin

getRemoteFrames

  • getRemoteFrames(): LayoutFrame[]
  • Gets the remote frames.

    Returns LayoutFrame[]

getTypeString

  • getTypeString(): string

  • Returns string

getWidth

  • getWidth(): number
  • Gets the layout width.

    Returns number

setHeight

  • setHeight(value: number): void
  • Sets the layout height.

    Parameters

    • value: number

    Returns void

setLocalFrame

  • setLocalFrame(value: LayoutFrame): void
  • Sets the local frame.

    Parameters

    • value: LayoutFrame

    Returns void

setOrigin

  • setOrigin(value: LayoutOrigin): void
  • Sets the layout origin.

    Parameters

    • value: LayoutOrigin

    Returns void

setRemoteFrames

  • setRemoteFrames(value: LayoutFrame[]): void
  • Sets the remote frames.

    Parameters

    • value: LayoutFrame[]

    Returns void

setWidth

  • setWidth(value: number): void
  • Sets the layout width.

    Parameters

    • value: number

    Returns void

swapFrames

  • swapFrames(frame1: LayoutFrame, frame2: LayoutFrame): void
  • Swaps the properties of two frames.

    Parameters

    • frame1: LayoutFrame

      The first frame.

    • frame2: LayoutFrame

      The second frame.

    Returns void

swapLocalFrame

  • swapLocalFrame(remoteFrameIndex: number): void
  • Swaps the local frame with a remote frame.

    Parameters

    • remoteFrameIndex: number

      The index of the remote frame.

    Returns void

swapRemoteFrames

  • swapRemoteFrames(remoteFrameIndex1: number, remoteFrameIndex2: number): void
  • Swaps two remote frames.

    Parameters

    • remoteFrameIndex1: number

      The index of the first remote frame.

    • remoteFrameIndex2: number

      The index of the second remote frame.

    Returns void