PERGOLA LOGO

pergola.Separator

System events: NO.

User events and functions: NO.

System component. Separators can be inserted between groups of tool buttons in tool bars (vertical), and between groups of menu items (horizontal). To insert a separator between tool buttons you must specify separator : true for the group that you wish to separate, example (contextual):

 this.addTools({
  selectGroup : {
    separator : true,
    selectionTool : {
      ...
    },
    ...

To insert a separator between menu items you must (only) instantiate this class (the build() method is invoked by the menu constructor). The separator is inserted after the menu item that defines the separator property, example (contextual):
 items : {
    ...,
    item3 : {
      string : "Menu Item #3",
      fn : myObject.message,
      separator : new pergola.Separator()
    },
    ...

Listed: class properties/methods; prototype properties and methods; instance properties. Prototype properties and methods inherited by the Class superclass are not listed.

class

None

prototype

PROPERTIES

parent

pergola.user. Must be overridden by controls using this class.

width

Defined in pergola.presentationAttributes – number (user space units).

height

Defined in pergola.presentationAttributes – number (user space units).

METHODS

build(object)

this inherits the properties specified in object. Prototype properties specified in object are overridden. Creates elements. Returns this.

instance

name

String. If not passed to the constructor, gets a generated XML name (Class).

id

String. The return value of this name.toXML(). This container ID. Used as prefix where other elements' IDs are attributed.

owner

If specified, designates the owner object.

container

<g> element.

type

String. Must be specified in the initialization object. Allowed values: "horizontal"; "vertical". The appropriate value is specified by the classes that are enabled to request a separator.