Options
All
  • Public
  • Public/Protected
  • All
Menu

Class PluginWrapper

Hierarchy

  • Element
    • PluginWrapper

Index

Properties

Methods

Properties

className

className: string

container

container: JQuery

controls

controls: Controls

dontAdd

dontAdd: boolean

editBtn

editBtn: ControlsButton

elem

elem: JQuery

groupId

groupId: string | null

groupPath

groupPath: string[] | null

hiddenResp

hiddenResp: boolean

id

id: string

includePages

includePages: object

Type declaration

  • [pid: string]: object
    • [langCode: string]: boolean

isCommon

isCommon: boolean

isFullWidth

isFullWidth: boolean

isLocked

isLocked: boolean

isResizable

isResizable: boolean

modes

modes: IDictionary<Mode>

moveBtn

moveBtn: ControlsButton

parent

parent: Content

removed

removed: boolean

snapData

snapData: object | null

Optional staticPos

staticPos: undefined | object

system

system: Builder

Static PluginElement

PluginElement: PluginElement

Plugin element factory.

Usage:

var elem = PluginWrapper.PluginElement.fromData(data);

Methods

applyComProperties

  • applyComProperties(): void

  • Returns void

cacheBounds

  • cacheBounds(): void

  • Returns void

closeComProperties

  • closeComProperties(): void

  • Returns void

comPropertiesField

  • Parameters

    • field: string

    Returns UIComponent

displayEmtyMessage

  • displayEmtyMessage(display: boolean, noText?: undefined | false | true): void

  • Display message to inform user how to change picture

    Parameters

    • display: boolean

      if true message will be displayed else hidden

    • Optional noText: undefined | false | true

      set true to hide text

    Returns void

fitToParent

  • fitToParent(): void

  • Returns void

getBounds

  • getBounds(asArray?: undefined | false | true, fast?: undefined | false | true): ElementBounds

  • Parameters

    • Optional asArray: undefined | false | true
    • Optional fast: undefined | false | true

    Returns ElementBounds

getClassType

  • getClassType(): string

  • Returns string

getHeight

  • getHeight(fast?: undefined | false | true): number

  • Parameters

    • Optional fast: undefined | false | true

    Returns number

getLocation

  • getLocation(fast?: undefined | false | true): object

  • Parameters

    • Optional fast: undefined | false | true

    Returns object

    • left: number
    • top: number

getParent

  • getParent(): Content

  • Returns Content

getRootGroupId

  • getRootGroupId(): string | null

  • Returns string | null

getSize

  • getSize(fast?: undefined | false | true): ISize

  • Parameters

    • Optional fast: undefined | false | true

    Returns ISize

getUsedFonts

  • getUsedFonts(): string[]

  • Returns string[]

getUsedMediaGalleryItems

  • getUsedMediaGalleryItems(): string[]

  • Returns string[]

getUsedSiteStyles

  • getUsedSiteStyles(): string[]

  • Returns string[]

getWidth

  • getWidth(fast?: undefined | false | true): number

  • Parameters

    • Optional fast: undefined | false | true

    Returns number

getZIndex

  • getZIndex(): number

  • Returns number

hide

  • hide(responsive: boolean, updateParentSize: boolean, manual: boolean): void
  • hide(responsive?: undefined | false | true, updateParentSize?: undefined | false | true, manual?: undefined | false | true): void

  • Hides element

    Parameters

    • responsive: boolean

      if false then hides element from current language (if website is multilang); if true then hides element in tablet/phone mode in recycle bin

    • updateParentSize: boolean

      if true then content height will be updated

    • manual: boolean

      true when was called by client from element context menu

    Returns void

  • Parameters

    • Optional responsive: undefined | false | true
    • Optional updateParentSize: undefined | false | true
    • Optional manual: undefined | false | true

    Returns void

isHidden

  • isHidden(responsive?: undefined | false | true): boolean

  • Parameters

    • Optional responsive: undefined | false | true

    Returns boolean

isSelected

  • isSelected(): boolean

  • Returns boolean

onDrag

  • onDrag(onConstruct?: undefined | false | true): void

  • Parameters

    • Optional onConstruct: undefined | false | true

    Returns void

onResize

  • onResize(initial?: undefined | false | true): void

  • Parameters

    • Optional initial: undefined | false | true

    Returns void

onStartResize

  • onStartResize(): void

  • Returns void

onStopResize

  • onStopResize(): void

  • Returns void

remove

  • remove(noHistory?: undefined | false | true): void

  • Parameters

    • Optional noHistory: undefined | false | true

    Returns void

setControlsVisible

  • setControlsVisible(visible: boolean): void

  • Parameters

    • visible: boolean

    Returns void

setFullWidth

  • setFullWidth(fullWidth: boolean): void

  • Parameters

    • fullWidth: boolean

    Returns void

setLocation

  • setLocation(left?: number | null, top?: number | null, fast?: undefined | false | true): void

  • Parameters

    • Optional left: number | null
    • Optional top: number | null
    • Optional fast: undefined | false | true

    Returns void

setLocked

  • setLocked(lock: boolean, initial?: undefined | false | true): void

  • Parameters

    • lock: boolean
    • Optional initial: undefined | false | true

    Returns void

setMinSize

  • setMinSize(width: number | null, height: number | null): void

  • Parameters

    • width: number | null
    • height: number | null

    Returns void

setResizingEnabled

  • setResizingEnabled(enabled: boolean, destroy?: undefined | false | true): void

  • Parameters

    • enabled: boolean
    • Optional destroy: undefined | false | true

    Returns void

setSelected

  • setSelected(selected: boolean, skipGroup?: undefined | false | true, skipFade?: undefined | false | true): void

  • Parameters

    • selected: boolean
    • Optional skipGroup: undefined | false | true
    • Optional skipFade: undefined | false | true

    Returns void

setSize

  • setSize(width?: number | null, height?: number | null): void

  • Parameters

    • Optional width: number | null
    • Optional height: number | null

    Returns void

showMeasurementHelpers

  • showMeasurementHelpers(show: boolean): void

  • Parameters

    • show: boolean

    Returns void

snapDone

  • snapDone(e: any, ui: any): void

  • Parameters

    • e: any
    • ui: any

    Returns void

snapMove

  • snapMove(e: any, ui: any): void

  • Parameters

    • e: any
    • ui: any

    Returns void

snapPrepare

  • snapPrepare(e: any, ui: any): void

  • Parameters

    • e: any
    • ui: any

    Returns void

snapResize

  • snapResize(e: object, ui: object): void

  • Parameters

    • e: object
      • type: "resize"
    • ui: object
      • position: object
        • left: number
        • top: number
      • size: object
        • height: number
        • width: number

    Returns void

Static addEventListener

  • addEventListener(event: string, func: function): void

  • Add event listener.

    Inside event listener you can access some plugin data from global variable pluginData, this variable is of type PluginGlobalLoadingData.

    Available events

    • builder.init - triggered when builder is fully initialized;
    • builder.beforesave - triggered before builder saves site data (events target will be PluginSite instance);
    • page.beforeload - triggered before page content starts loading;
    • page.load - triggered after page content is loaded;
    • templates.show - triggered when template chooser is shown;
    • templates.hide - triggered when template chooser is hidden;
    • contextmenu.show - triggered before context menu is shown (useful for modifying context menu);

    Parameters

    • event: string

      Event type.

    • func: function

      Event handler function.

    Returns void

Static registerPlugin

  • Register element plugin.

    Parameters

    • id: string

      Unique plugin identifier (use standard variable naming conventions).

    • def: PluginDefinition

      Plugin definition object.

    Returns void

Static removeEventListener

  • removeEventListener(event: string, func: function): void

  • Remove event listener.

    Parameters

    Returns void