Options
All
  • Public
  • Public/Protected
  • All
Menu

Class LayoutFrame

A layout frame definition, including X/Y coordinates and width/height values.

Hierarchy

  • LayoutFrame

Index

Constructors

Properties

Methods

Constructors

constructor

  • new LayoutFrame(x: number, y: number, width: number, height: number): LayoutFrame
  • new LayoutFrame(): LayoutFrame
  • Initializes a new instance of the fm.icelink.layoutFrame class.

    Parameters

    • x: number

      The X coordinate.

    • y: number

      The Y coordinate.

    • width: number

      The width value.

    • height: number

      The height value.

    Returns LayoutFrame

  • Initializes a new instance of the fm.icelink.layoutFrame class.

    Returns LayoutFrame

Properties

Private _height

_height: number
internal

Private _width

_width: number
internal

Private _x

_x: number
internal

Private _y

_y: number
internal

Methods

getHeight

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

    Returns number

getTypeString

  • getTypeString(): string

  • Returns string

getWidth

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

    Returns number

getX

  • getX(): number
  • Gets the X coordinate.

    Returns number

getY

  • getY(): number
  • Gets the Y coordinate.

    Returns number

isEquivalent

  • isEquivalent(layoutFrame: LayoutFrame): boolean
  • Determines whether the specified layout frame is equivalent.

    Parameters

    • layoutFrame: LayoutFrame

      The layout frame.

    Returns boolean

setHeight

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

    Parameters

    • value: number

    Returns void

setWidth

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

    Parameters

    • value: number

    Returns void

setX

  • setX(value: number): void
  • Sets the X coordinate.

    Parameters

    • value: number

    Returns void

setY

  • setY(value: number): void
  • Sets the Y coordinate.

    Parameters

    • value: number

    Returns void

toJson

  • toJson(): string
  • Serializes this instance to JSON.

    Returns string

Static fromJson

  • fromJson(layoutFrameJson: string): LayoutFrame
  • Deserializes a layout frame from JSON.

    Parameters

    • layoutFrameJson: string

      The layout frame JSON.

    Returns LayoutFrame

Static getScaledFrame

  • getScaledFrame(scale: LayoutScale, outerWidth: number, outerHeight: number, innerWidth: number, innerHeight: number): LayoutFrame
  • Gets a scaled frame.

    Parameters

    • scale: LayoutScale

      The scaling algorithm to use.

    • outerWidth: number

      The width of the outer container.

    • outerHeight: number

      The height of the outer container.

    • innerWidth: number

      The width of the inner element.

    • innerHeight: number

      The height of the inner element.

    Returns LayoutFrame

Static toJson

  • toJson(layoutFrame: LayoutFrame): string
  • Serializes a layout frame to JSON.

    Parameters

    • layoutFrame: LayoutFrame

      The layout frame.

    Returns string