Options
All
  • Public
  • Public/Protected
  • All
Menu

Class LayoutPreset

A layout preset.

Hierarchy

  • Dynamic
    • LayoutPreset

Index

Constructors

Properties

Methods

Constructors

constructor

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

    Returns LayoutPreset

Properties

Private __blockHeight

__blockHeight: number
internal

Private __blockHeightPercent

__blockHeightPercent: number
internal

Private __blockMarginX

__blockMarginX: number
internal

Private __blockMarginXPercent

__blockMarginXPercent: number
internal

Private __blockMarginY

__blockMarginY: number
internal

Private __blockMarginYPercent

__blockMarginYPercent: number
internal

Private __blockWidth

__blockWidth: number
internal

Private __blockWidthPercent

__blockWidthPercent: number
internal

Private __floatHeight

__floatHeight: number
internal

Private __floatHeightPercent

__floatHeightPercent: number
internal

Private __floatMarginX

__floatMarginX: number
internal

Private __floatMarginXPercent

__floatMarginXPercent: number
internal

Private __floatMarginY

__floatMarginY: number
internal

Private __floatMarginYPercent

__floatMarginYPercent: number
internal

Private __floatWidth

__floatWidth: number
internal

Private __floatWidthPercent

__floatWidthPercent: number
internal

Private _alignment

_alignment: LayoutAlignment
internal

Private _direction

_direction: LayoutDirection
internal

Private _inlineMargin

_inlineMargin: number
internal

Private _mode

_mode: LayoutMode
internal

Methods

applyPreset

  • applyPreset(preset: LayoutPreset): void
  • Applies a preset.

    Parameters

    • preset: LayoutPreset

      The preset to apply.

    Returns void

Private calculateBlockFrame

  • calculateBlockFrame(layoutWidth: number, layoutHeight: number, marginX: Holder<number>, marginY: Holder<number>): LayoutFrame
  • internal

    Parameters

    • layoutWidth: number
    • layoutHeight: number
    • marginX: Holder<number>
    • marginY: Holder<number>

    Returns LayoutFrame

Private calculateFillFrame

  • calculateFillFrame(layoutWidth: number, layoutHeight: number): LayoutFrame
  • internal

    Parameters

    • layoutWidth: number
    • layoutHeight: number

    Returns LayoutFrame

Private calculateFloatFrame

  • calculateFloatFrame(layoutWidth: number, layoutHeight: number): LayoutFrame
  • internal

    Parameters

    • layoutWidth: number
    • layoutHeight: number

    Returns LayoutFrame

Private calculateFloatFrames

  • calculateFloatFrames(layoutWidth: number, layoutHeight: number, count: number): LayoutFrame[]
  • internal

    Parameters

    • layoutWidth: number
    • layoutHeight: number
    • count: number

    Returns LayoutFrame[]

Private calculateInlineFrame

  • calculateInlineFrame(cellX: number, cellY: number, cellWidth: number, cellHeight: number): LayoutFrame
  • internal

    Parameters

    • cellX: number
    • cellY: number
    • cellWidth: number
    • cellHeight: number

    Returns LayoutFrame

Private calculateInlineFrames

  • calculateInlineFrames(layoutWidth: number, layoutHeight: number, count: number, baseX: number, baseY: number): LayoutFrame[]
  • internal

    Parameters

    • layoutWidth: number
    • layoutHeight: number
    • count: number
    • baseX: number
    • baseY: number

    Returns LayoutFrame[]

calculateLayout

  • calculateLayout(layoutWidth: number, layoutHeight: number, remoteCount: number, origin: LayoutOrigin): Layout
  • Gets a video frame layout.

    Parameters

    • layoutWidth: number

      The total width of the layout.

    • layoutHeight: number

      The total height of the layout.

    • remoteCount: number

      The number of remote frames.

    • origin: LayoutOrigin

      The layout origin

    Returns Layout

    The video frame layout.

copyToPreset

  • copyToPreset(preset: LayoutPreset): void
  • Copies this preset's properties to another preset.

    Parameters

    • preset: LayoutPreset

      The target preset.

    Returns void

getAlignment

  • getAlignment(): LayoutAlignment
  • Gets the alignment of the layout. Defaults to fm.icelink.layoutAlignment.BottomRight.

    Returns LayoutAlignment

getBlockHeight

  • getBlockHeight(): number
  • Gets the height of block elements in pixels. Overrides fm.icelink.layoutPreset.blockHeightPercent.

    Returns number

getBlockHeightPercent

  • getBlockHeightPercent(): number
  • Gets the height of block elements as a percent of the container height between 0.0 and 1.0. Overrides fm.icelink.layoutPreset.blockHeight.

    Returns number

Private getBlockLayout

  • getBlockLayout(layoutWidth: number, layoutHeight: number, remoteCount: number): Layout
  • internal

    Parameters

    • layoutWidth: number
    • layoutHeight: number
    • remoteCount: number

    Returns Layout

getBlockMarginX

  • getBlockMarginX(): number
  • Gets the X-margin between block elements and the layout edge in pixels. Overrides fm.icelink.layoutPreset.blockMarginXPercent.

    Returns number

getBlockMarginXPercent

  • getBlockMarginXPercent(): number
  • Gets the X-margin between block elements and the layout edge as a percent of the container width between 0.0 and 1.0. Overrides fm.icelink.layoutPreset.blockMarginX.

    Returns number

getBlockMarginY

  • getBlockMarginY(): number
  • Gets the Y-margin between block elements and the layout edge in pixels. Overrides fm.icelink.layoutPreset.blockMarginYPercent.

    Returns number

getBlockMarginYPercent

  • getBlockMarginYPercent(): number
  • Gets the Y-margin between block elements and the layout edge as a percent of the container height between 0.0 and 1.0. Overrides fm.icelink.layoutPreset.blockMarginY.

    Returns number

getBlockWidth

  • getBlockWidth(): number
  • Gets the width of block elements in pixels. Overrides fm.icelink.layoutPreset.blockWidthPercent.

    Returns number

getBlockWidthPercent

  • getBlockWidthPercent(): number
  • Gets the width of block elements as a percent of the container width between 0.0 and 1.0. Overrides fm.icelink.layoutPreset.blockWidth.

    Returns number

Private getBottomRowIndexes

  • getBottomRowIndexes(frames: LayoutFrame[]): number[]
  • internal

    Parameters

    • frames: LayoutFrame[]

    Returns number[]

Private getCenterColumnIndexes

  • getCenterColumnIndexes(frames: LayoutFrame[]): number[]
  • internal

    Parameters

    • frames: LayoutFrame[]

    Returns number[]

Private getCenterRowIndexes

  • getCenterRowIndexes(frames: LayoutFrame[]): number[]
  • internal

    Parameters

    • frames: LayoutFrame[]

    Returns number[]

getDirection

  • getDirection(): LayoutDirection
  • Gets the direction of the layout flow. Defaults to fm.icelink.layoutDirection.Horizontal.

    Returns LayoutDirection

getDynamicProperties

  • getDynamicProperties(): Hash<string, Object>
  • Gets the dynamic properties on this instance.

    Returns Hash<string, Object>

getDynamicValue

  • getDynamicValue(key: string): Object
  • Gets a property value from the local cache.

    Parameters

    • key: string

      The property key. This key is used internally only, but should be namespaced to avoid conflict with third-party extensions.

    Returns Object

    The stored value, if found; otherwise null.

getFloatHeight

  • getFloatHeight(): number
  • Gets the height of floating elements in pixels. Overrides fm.icelink.layoutPreset.floatHeightPercent.

    Returns number

getFloatHeightPercent

  • getFloatHeightPercent(): number
  • Gets the height of floating elements as a percent of the container height between 0.0 and 1.0. Overrides fm.icelink.layoutPreset.floatHeight.

    Returns number

Private getFloatLocalLayout

  • getFloatLocalLayout(layoutWidth: number, layoutHeight: number, remoteCount: number): Layout
  • internal

    Parameters

    • layoutWidth: number
    • layoutHeight: number
    • remoteCount: number

    Returns Layout

getFloatMarginX

  • getFloatMarginX(): number
  • Gets the X-margin between floating elements and the layout edge in pixels. Overrides fm.icelink.layoutPreset.floatMarginXPercent.

    Returns number

getFloatMarginXPercent

  • getFloatMarginXPercent(): number
  • Gets the X-margin between floating elements and the layout edge as a percent of the container width between 0.0 and 1.0. Overrides fm.icelink.layoutPreset.floatMarginX.

    Returns number

getFloatMarginY

  • getFloatMarginY(): number
  • Gets the Y-margin between floating elements and the layout edge in pixels. Overrides fm.icelink.layoutPreset.floatMarginYPercent.

    Returns number

getFloatMarginYPercent

  • getFloatMarginYPercent(): number
  • Gets the Y-margin between floating elements and the layout edge as a percent of the container height between 0.0 and 1.0. Overrides fm.icelink.layoutPreset.floatMarginY.

    Returns number

Private getFloatRemoteLayout

  • getFloatRemoteLayout(layoutWidth: number, layoutHeight: number, remoteCount: number): Layout
  • internal

    Parameters

    • layoutWidth: number
    • layoutHeight: number
    • remoteCount: number

    Returns Layout

getFloatWidth

  • getFloatWidth(): number
  • Gets the width of floating elements in pixels. Overrides fm.icelink.layoutPreset.floatWidthPercent.

    Returns number

getFloatWidthPercent

  • getFloatWidthPercent(): number
  • Gets the width of floating elements as a percent of the container width between 0.0 and 1.0. Overrides fm.icelink.layoutPreset.floatWidth.

    Returns number

Private getInlineLayout

  • getInlineLayout(layoutWidth: number, layoutHeight: number, remoteCount: number): Layout
  • internal

    Parameters

    • layoutWidth: number
    • layoutHeight: number
    • remoteCount: number

    Returns Layout

getInlineMargin

  • getInlineMargin(): number
  • Gets the size of the margin in pixels to use between inline elements.

    Returns number

getIsDirty

  • getIsDirty(): boolean
  • Gets a value indicating whether this instance is dirty.
    internal

    Returns boolean

getIsSerialized

  • getIsSerialized(): boolean

Private getLeftColumnIndexes

  • getLeftColumnIndexes(frames: LayoutFrame[]): number[]
  • internal

    Parameters

    • frames: LayoutFrame[]

    Returns number[]

getMode

  • getMode(): LayoutMode
  • Gets the mode used by the layout engine. Defaults to fm.icelink.layoutMode.FloatLocal.

    Returns LayoutMode

Private getRightColumnIndexes

  • getRightColumnIndexes(frames: LayoutFrame[]): number[]
  • internal

    Parameters

    • frames: LayoutFrame[]

    Returns number[]

getSerialized

  • getSerialized(): string

Private getTopRowIndexes

  • getTopRowIndexes(frames: LayoutFrame[]): number[]
  • internal

    Parameters

    • frames: LayoutFrame[]

    Returns number[]

getTypeString

  • getTypeString(): string

setAlignment

  • setAlignment(value: LayoutAlignment): void
  • Sets the alignment of the layout. Defaults to fm.icelink.layoutAlignment.BottomRight.

    Parameters

    • value: LayoutAlignment

    Returns void

setBlockHeight

  • setBlockHeight(value: number): void
  • Sets the height of block elements in pixels. Overrides fm.icelink.layoutPreset.blockHeightPercent.

    Parameters

    • value: number

    Returns void

setBlockHeightPercent

  • setBlockHeightPercent(value: number): void
  • Sets the height of block elements as a percent of the container height between 0.0 and 1.0. Overrides fm.icelink.layoutPreset.blockHeight.

    Parameters

    • value: number

    Returns void

setBlockMarginX

  • setBlockMarginX(value: number): void
  • Sets the X-margin between block elements and the layout edge in pixels. Overrides fm.icelink.layoutPreset.blockMarginXPercent.

    Parameters

    • value: number

    Returns void

setBlockMarginXPercent

  • setBlockMarginXPercent(value: number): void
  • Sets the X-margin between block elements and the layout edge as a percent of the container width between 0.0 and 1.0. Overrides fm.icelink.layoutPreset.blockMarginX.

    Parameters

    • value: number

    Returns void

setBlockMarginY

  • setBlockMarginY(value: number): void
  • Sets the Y-margin between block elements and the layout edge in pixels. Overrides fm.icelink.layoutPreset.blockMarginYPercent.

    Parameters

    • value: number

    Returns void

setBlockMarginYPercent

  • setBlockMarginYPercent(value: number): void
  • Sets the Y-margin between block elements and the layout edge as a percent of the container height between 0.0 and 1.0. Overrides fm.icelink.layoutPreset.blockMarginY.

    Parameters

    • value: number

    Returns void

setBlockWidth

  • setBlockWidth(value: number): void
  • Sets the width of block elements in pixels. Overrides fm.icelink.layoutPreset.blockWidthPercent.

    Parameters

    • value: number

    Returns void

setBlockWidthPercent

  • setBlockWidthPercent(value: number): void
  • Sets the width of block elements as a percent of the container width between 0.0 and 1.0. Overrides fm.icelink.layoutPreset.blockWidth.

    Parameters

    • value: number

    Returns void

setDirection

  • setDirection(value: LayoutDirection): void
  • Sets the direction of the layout flow. Defaults to fm.icelink.layoutDirection.Horizontal.

    Parameters

    • value: LayoutDirection

    Returns void

setDynamicProperties

  • setDynamicProperties(value: Hash<string, Object>): void
  • internal

    Parameters

    • value: Hash<string, Object>

    Returns void

setDynamicValue

  • setDynamicValue(key: string, value: Object): void
  • Sets a property value in the local cache.

    Parameters

    • key: string

      The property key. This key is used internally only, but should be namespaced to avoid conflict with third-party extensions.

    • value: Object

      The property value. This can be any object that needs to be stored for future use.

    Returns void

setFloatHeight

  • setFloatHeight(value: number): void
  • Sets the height of floating elements in pixels. Overrides fm.icelink.layoutPreset.floatHeightPercent.

    Parameters

    • value: number

    Returns void

setFloatHeightPercent

  • setFloatHeightPercent(value: number): void
  • Sets the height of floating elements as a percent of the container height between 0.0 and 1.0. Overrides fm.icelink.layoutPreset.floatHeight.

    Parameters

    • value: number

    Returns void

setFloatMarginX

  • setFloatMarginX(value: number): void
  • Sets the X-margin between floating elements and the layout edge in pixels. Overrides fm.icelink.layoutPreset.floatMarginXPercent.

    Parameters

    • value: number

    Returns void

setFloatMarginXPercent

  • setFloatMarginXPercent(value: number): void
  • Sets the X-margin between floating elements and the layout edge as a percent of the container width between 0.0 and 1.0. Overrides fm.icelink.layoutPreset.floatMarginX.

    Parameters

    • value: number

    Returns void

setFloatMarginY

  • setFloatMarginY(value: number): void
  • Sets the Y-margin between floating elements and the layout edge in pixels. Overrides fm.icelink.layoutPreset.floatMarginYPercent.

    Parameters

    • value: number

    Returns void

setFloatMarginYPercent

  • setFloatMarginYPercent(value: number): void
  • Sets the Y-margin between floating elements and the layout edge as a percent of the container height between 0.0 and 1.0. Overrides fm.icelink.layoutPreset.floatMarginY.

    Parameters

    • value: number

    Returns void

setFloatWidth

  • setFloatWidth(value: number): void
  • Sets the width of floating elements in pixels. Overrides fm.icelink.layoutPreset.floatWidthPercent.

    Parameters

    • value: number

    Returns void

setFloatWidthPercent

  • setFloatWidthPercent(value: number): void
  • Sets the width of floating elements as a percent of the container width between 0.0 and 1.0. Overrides fm.icelink.layoutPreset.floatWidth.

    Parameters

    • value: number

    Returns void

setInlineMargin

  • setInlineMargin(value: number): void
  • Sets the size of the margin in pixels to use between inline elements.

    Parameters

    • value: number

    Returns void

setIsDirty

  • setIsDirty(value: boolean): void
  • Sets a value indicating whether this instance is dirty.
    internal

    Parameters

    • value: boolean

    Returns void

setIsSerialized

  • setIsSerialized(value: boolean): void
  • internal

    Parameters

    • value: boolean

    Returns void

setMode

  • setMode(value: LayoutMode): void
  • Sets the mode used by the layout engine. Defaults to fm.icelink.layoutMode.FloatLocal.

    Parameters

    • value: LayoutMode

    Returns void

setSerialized

  • setSerialized(value: string): void
  • internal

    Parameters

    • value: string

    Returns void

unsetDynamicValue

  • unsetDynamicValue(key: string): boolean
  • Unsets a property value in the local cache.

    Parameters

    • key: string

      The property key. This key is used internally only, but should be namespaced to avoid conflict with third-party extensions.

    Returns boolean

    true if the value was removed; otherwise, false.

Static Private calculateTable

  • calculateTable(tableWidth: number, tableHeight: number, count: number): LayoutTable
  • internal

    Parameters

    • tableWidth: number
    • tableHeight: number
    • count: number

    Returns LayoutTable

Static Private divideByTwo

  • divideByTwo(value: number): number
  • internal

    Parameters

    • value: number

    Returns number

Static getFacetime

  • getFacetime(): LayoutPreset
  • Gets a Facetime-style layout preset.

    Returns LayoutPreset

Static getGoogleHangouts

  • getGoogleHangouts(): LayoutPreset
  • Gets a Google Hangouts-style layout preset. Note that this will present differently on mobile devices.

    Returns LayoutPreset

Static Private getSingleLayout

  • getSingleLayout(layoutWidth: number, layoutHeight: number): Layout
  • internal

    Parameters

    • layoutWidth: number
    • layoutHeight: number

    Returns Layout

Static getSkype

  • getSkype(): LayoutPreset
  • Gets a Skype-style layout preset. Note that this will present differently on mobile devices.

    Returns LayoutPreset

Static Private getXMax

  • getXMax(frames: LayoutFrame[]): number
  • internal

    Parameters

    • frames: LayoutFrame[]

    Returns number

Static Private getXMid

  • getXMid(frames: LayoutFrame[]): number
  • internal

    Parameters

    • frames: LayoutFrame[]

    Returns number

Static Private getXMin

  • getXMin(frames: LayoutFrame[]): number
  • internal

    Parameters

    • frames: LayoutFrame[]

    Returns number

Static Private getYMax

  • getYMax(frames: LayoutFrame[]): number
  • internal

    Parameters

    • frames: LayoutFrame[]

    Returns number

Static Private getYMid

  • getYMid(frames: LayoutFrame[]): number
  • internal

    Parameters

    • frames: LayoutFrame[]

    Returns number

Static Private getYMin

  • getYMin(frames: LayoutFrame[]): number
  • internal

    Parameters

    • frames: LayoutFrame[]

    Returns number

Static Private mergeLayoutFrames

  • mergeLayoutFrames(firstFrames: LayoutFrame[], lastFrames: LayoutFrame[]): LayoutFrame[]
  • internal

    Parameters

    • firstFrames: LayoutFrame[]
    • lastFrames: LayoutFrame[]

    Returns LayoutFrame[]

Static Private spliceLayoutFrame

  • spliceLayoutFrame(frames: LayoutFrame[], index: number): LayoutFrame[]
  • internal

    Parameters

    • frames: LayoutFrame[]
    • index: number

    Returns LayoutFrame[]

Static Private takeLayoutFrames

  • takeLayoutFrames(frames: LayoutFrame[], start: number, length: number): LayoutFrame[]
  • internal

    Parameters

    • frames: LayoutFrame[]
    • start: number
    • length: number

    Returns LayoutFrame[]

Static transformFrame

  • transformFrame(frame: LayoutFrame, origin: LayoutOrigin, layoutWidth: number, layoutHeight: number): void
  • internal

    Parameters

    • frame: LayoutFrame
    • origin: LayoutOrigin
    • layoutWidth: number
    • layoutHeight: number

    Returns void