Expand all

abstract ve.ui.FragmentWindow

Constructor

new ve.ui.FragmentWindow([config])abstract #

Mixin for window for working with fragments of content.

Parameters:

Name Type Attributes Description
config Object optional

Configuration options
Source:
Mixin for window for working with fragments of content.

Methods

getActionWidgetConfig() #

Source:
See:

getFragment() → {ve.dm.SurfaceFragment|null} #

Get the surface fragment the window is for.

Source:

Returns:

Surface fragment the window is for, null if the window is closed

Type
ve.dm.SurfaceFragment | null
Get the surface fragment the window is for.

getMode() → {string} #

Get a symbolic mode name.

By default will return 'edit' if #isEditing is true, and 'insert' otherwise.

If the surface model is in read-only mode, will return 'readonly'.

Source:

Returns:

Symbolic mode name

Type
string
Get a symbolic mode name.

getSetupProcess() #

Source:
See:

Throws:

If fragment was not provided through data parameter

Type
Error

getTeardownProcess() #

Source:
See:

isEditing() → {boolean} #

Check if the current fragment is editable by this window.

Source:

Returns:

Fragment is editable by this window

Type
boolean
Check if the current fragment is editable by this window.

isReadOnly() → {boolean} #

Check if the fragment's surface is readOnly

Source:

Returns:

Fragment's surface is readOnly

Type
boolean
Check if the fragment's surface is readOnly