Surface class

Requires

• module:exontrol.commmon.min.js

Classes

ElementOptions

LinkOptions

Options

Members

CanRedo

Since:

• 2.0

Example

false {boolean}, no Redo operation is permitted
  true {boolean}, a Redo operation is available

CanUndo

Since:

• 2.0

Example

false {boolean}, no Undo operation is permitted
  true {boolean}, an Undo operation is available

EndBlockUndoRedo

Since:

• 2.0

Example

oControl.StartBlockUndoRedo()
   ...
 oControl.EndBlockUndoRedo()

GetAllowUndoRedo

Since:

• 2.0

Example

false {boolean}, the Undo/Redo feature is disabled (by default)
  true {boolean}, the Undo/Redo feature is enabled.

GetUndoRedoQueueLength

Since:

• 2.0

Example

-1 {number}, the Undo/Redo queue is limitless
  1 {number}, the Undo/Redo queue limits the number of actions to store to 1 (one action or one block of actions)

Listeners :exontrol.Lts

Type:

• exontrol.Lts

Example

The following sample shows how you can get all events the component currently supports:

oSurface.Listeners.forEach(function(name)
{
 console.log(name);
});

The following sample displays the element being clicked:

oSurface.Listeners.Add("onclick", function (oEvent)
{
 console.log(oEvent);
});

or

oSurface.on("click", function (oEvent)
{
 console.log(oEvent);
});

where oSurface is an object of Surface type

Redo

Since:

• 2.0

Example

Redo(), redoes the last action that was undone

SetAllowUndoRedo

Since:

• 2.0

Example

false {boolean}, the Undo/Redo feature is disabled (by default)
  true {boolean}, enables the Undo/Redo feature.

SetUndoRedoQueueLength

Since:

• 2.0

Example

-1 {number}, the Undo/Redo queue is limitless
  1 {number}, the Undo/Redo queue limits the number of actions to store to 1 (one action or one block of actions)

Shortcuts :exontrol.Sts

Type:

• exontrol.Sts

Example

The following sample removes the selection (calls the RemoveSelection() method) once the user presses the Delete key:

oSurface.Shortcuts.Add( "Delete", oSurface.RemoveSelection, oSurface );

where oSurface is an object of Surface type

StartBlockUndoRedo

Since:

• 2.0

Example

oControl.StartBlockUndoRedo()
   ...
 oControl.EndBlockUndoRedo()

Undo

Since:

• 2.0

Example

Undo(), undoes the last control operation

oSV :SV

Type:

• SV

(static, readonly) CoordEnum :number

Type:

• number

Properties:

Since:

• 1.3

(static, readonly) LinkControlPointEnum :number

Type:

• number

Properties:

(static, readonly) SingleSelEnum :number

Type:

• number

Properties:

(static) type :string

Type:

• string

Since:

• 1.8

(static) version :string

Type:

• string

Methods

BeginUpdate()

BlockUndoRedo(callback, thisArg)

Parameters:

Element(id) → {Element}

Parameters:

Since:

• 1.1

Returns:

Type

Element

EndUpdate()

GetLayout(oOptsopt) → {string}

Parameters:

Since:

• 1.8

Returns:

Type

string

Example

The following statements are equivalents:

 oSurface.GetLayout(), gets the control's layout
 oSurface.Layout, gets the control's layout

where oSurface is an object of Surface type

GetStatistics() → {string}

Returns:

Type

string

GroupUndoRedoActions(countopt)

Parameters:

Since:

• 2.0

Example

GroupUndoRedoActions(), groups all Undo/Redo operations into a block

Link(id) → {Link}

Parameters:

Since:

• 1.1

Returns:

Type

Link

RedoListAction(actionopt, countopt) → {string}

Parameters:

Since:

• 2.0

Returns:

Type

string

Example

RedoListAction(), lists all Redo actions that can be executed
  RedoListAction("*Element"), lists all "*Element" Redo actions that can be executed, such as AddElement, RemoveElement, UpdateElement or MoveElement
  RedoListAction("AddElement"), lists first "AddElement" Redo actions that can be executed

RedoRemoveAction(actionopt, countopt)

Parameters:

Since:

• 2.0

Example

RedoRemoveAction(), removes all actions from the Redo queue
  RedoRemoveAction("*Element"), removes all "*Element" actions, such as AddElement, RemoveElement, UpdateElement or MoveElement, from the Redo queue
  RedoRemoveAction("AddElement"), removes the first "AddElement" Redo action from the Redo queue

SetLayout(layout, oOptsopt)

Parameters:

Since:

• 1.8

UndoListAction(actionopt, countopt) → {string}

Parameters:

Since:

• 2.0

Returns:

Type

string

Example

UndoListAction(), lists all Undo actions that can be executed
  UndoListAction("*Element"), lists all "*Element" Undo actions that can be executed, such as AddElement, RemoveElement, UpdateElement or MoveElement.
  UndoListAction("AddElement",1), lists first "AddElement" Undo actions that can be executed

UndoRemoveAction(actionopt, countopt)

Parameters:

Since:

• 2.0

Example

UndoRemoveAction(), removes all actions from the Undo queue
  UndoRemoveAction("*Element"), removes all "*Element" actions, such as AddElement, RemoveElement, UpdateElement or MoveElement, from the Undo queue
  UndoRemoveAction("AddElement"), removes the first "AddElement" Undo action from the Undo queue

Update(callback, thisArgopt)

Parameters:

feE(callback, thisArgopt)

Parameters:

Since:

• 4.0

Example

Below is a sample showing the captions for all elements:

oSurface.feE(function(oElement)
{
   console.log(oElement.Caption)
})

feEU(callback, thisArgopt) → {any}

Parameters:

Since:

• 4.0

Returns:

Type

any

Example

The following sample displays the caption of the first non-movable element:

console.log(oSurface.feEU(function(oElement)
{
   return !oElement.isMovable() && oElement.Caption || "";
}))

feL(callback, thisArgopt)

Parameters:

Since:

• 4.0

Example

Below is a sample showing the all links (from, to):

oSurface.feL(function(oLink)
{
   console.log(oLink.From, "->", oLink.To)
})

feLU(callback, thisArgopt) → {any}

Parameters:

Since:

• 4.0

Returns:

Type

any

Example

The following sample displays the first hidden link:

console.log(oSurface.feLU(function(oLink)
{
   return !oLink.isVisible() && (oLink.From + "->" + oLink.To) || "";
}))

off(event, listener, methodopt)

Parameters:

Since:

• 4.4

Example

The following example removes the click event handler from the control:

oSurface.off("click");

where oSurface is an object of Surface type.

This sample is equivalent to:

oSurface.Listeners.Remove("onclick");

The following example removes all event handlers from the control:

oSurface.off();

where oSurface is an object of Surface type.

This sample is equivalent to:

oSurface.Listeners.Clear();

or

oSurface.Listeners.Remove();

on(event, listener, methodopt) → {object}

Parameters:

Since:

• 4.4

Returns:

Type

object

Example

The following example logs event details when the control is clicked:

oSurface.on("click", function(oEvent)
{
  console.log(oEvent);
});

where oSurface is an object of Surface type.

This sample is quivalent of 

oSurface.Listeners.Add("onclick", function (oEvent)
{
  console.log(oEvent);
});