PoolSplitter class (Swimlane)

PoolSplitter(oOpts)

new PoolSplitter(oOpts)

The PoolSplitter class defines a splitter within a pool. The lanes and phases of the pools are treated as splitters. The PoolSplitter class is used by the pool to define its lanes and phases, and to manage their properties such as caption, size, shape, etc. The Element.Lane and Element.Phase properties return an object of PoolSplitter type for each lane and phase of the pool, respectively. The Index property gets the zero-based index of a splitter (lane or phase) within its pool. The Caption property specifies the ex-HTML caption of the lane or phase, while the Size property defines the lane's height or the phase's width. The Shape property defines the visual style of an individual lane or phase.

The PoolSplitter class includes the following members:

  • pool {Pool}, indicates the owner pool
  • index {number}, specifies the index of the splitter
  • caption {string}, defines the caption of the splitter
  • size {number}, indicates the size of the splitter or null if the [size] flag is missing
  • shape {string}, specifies the shape to be applied on the splitter

The PoolSplitter object includes the following additional members:

lanes {object}, defines the pool's lanes (result of the Element.Lane property)
or
phases {object}, defines the pool's phases (result of the Element.Phase property)

Parameters:
Name Type Description
oOpts object Indicates the options of the splitter as an object of {pool,caption,size,shape,index,lanes} or {pool,caption,size,shape,index,phases} type, where:
  • pool {Pool}, indicates the owner pool
  • caption {string}, defines the ex-HTML caption of the splitter
  • size {number}, indicates the size of the splitter or null if the [size] flag is missing
  • shape {string}, specifies the shape to be applied on the splitter
  • index {number}, specifies the index of the splitter (0-based index of the lane or phase within the pool)
  • lanes {PoolSplitters}, defines the pool's lanes, if the splitter is a lane-splitter
  • phases {PoolSplitters}, defines the pool's phases, if the splitter is a phase-splitter

Members

Caption :string

The Caption property defines the ex-HTML caption of the splitter (lane or phase). It can include plain text, ex-HTML tags for formatting (such as <b> for bold), or even references to images (using <img> tags). The Size property defines the lane's height or the phase's width. The Shape property defines the visual style of an individual lane or phase.
Type:
  • string
Since:
  • 1.8
Example
The following statements are equivalent:

 oSwimlane.Element(0).Lane.Caption = "Lane 1", sets the caption of the first lane within the pool to "Lane 1"
 oSwimlane.Element(0).Phase.Caption = "Phase 1", sets the caption of the first phase within the pool to "Phase 1"
 oSwimlane.Element(0).Lane.SetCaption("Lane 1"), sets the caption of the first lane within the pool to "Lane 1"
 oSwimlane.Element(0).Phase.SetCaption("Phase 1"), sets the caption of the first phase within the pool to "Phase 1"

where oSwimlane is an object of Swimlane type
Caption

Client :array

The Client property determines the splitter's client-rectangle (absolute-coordinates), excluding the header's portion of the pool. The client-rectangle is the portion of the pool's rectangle that is occupied by the splitter (lane or phase) and is used to determine the splitter's size and position within the pool. The Client property defines the client-rectangle of the splitter as an array of [x,y,width,height] type.
Type:
  • array
Since:
  • 5.3
Example
The following statements are equivalent:

 oSwimlane.Element(0).Lane.Client {array}, returns the client-rectangle of the first lane within the pool as an array of [x,y,width,height] type
 oSwimlane.Element(0).Phase.Client {array}, returns the client-rectangle of the first phase within the pool as an array of [x,y,width,height] type
 oSwimlane.Element(0).Lane.GetClient() {array}, returns the client-rectangle of the first lane within the pool as an array of [x,y,width,height] type
 oSwimlane.Element(0).Phase.GetClient() {array}, returns the client-rectangle of the first phase within the pool as an array of [x,y,width,height] type
 
where oSwimlane is an object of Swimlane type
Client

(readonly) Index :number

The Index property gets the zero-based index of a splitter (lane or phase) within its pool. The Caption property specifies the ex-HTML caption of the lane or phase, while the Size property defines the lane's height or the phase's width. The Shape property defines the visual style of an individual lane or phase.
Type:
  • number
Since:
  • 1.8
Example
The following statements are equivalent:

 oSwimlane.Element(0).Lane.Index {number}, returns the index of the first lane within the pool
 oSwimlane.Element(0).Phase.Index {number}, returns the index of the first phase within the pool
 oSwimlane.Element(0).Lane.GetIndex() {number}, returns the index of the first lane within the pool
 oSwimlane.Element(0).Phase.GetIndex() {number}, returns the index of the first phase within the pool
 
where oSwimlane is an object of Swimlane type
Index

Shape :any

The Shape property defines the shape of the splitter (lane or phase). The Caption property specifies the ex-HTML caption of the lane or phase, while the Size property defines the lane's height or the phase's width. The Shape property defines the visual style of an individual lane or phase. By default, if no individual shape is assigned, the Shapes property defines the visual appearance of the pool's parts:
  • "lane", defines the visual-appearance of all lanes for all pools
  • "laneAlt", defines the visual-appearance of alternate lanes for all pools
  • "phase", defines the visual-appearance of all phases for all pools
  • "phaseAlt", defines the visual-appearance of alternate phases for all pools

The value of the Shape property could be any of the following:

  • {null}, no custom-shape is applied
  • the shape's name within the exontrol.Shapes.Swimlane or exontrol.Shapes namespace
  • a CSS color
  • a JSON string-representation of an object of exontrol.Def.Shape type
  • an object of {normal,hover,click,disabled} type. The normal, hover, click and disabled are objects of exontrol.Def.Shape type
Type:
  • any
Since:
  • 1.8
Example
The following statements are equivalent:

 oSwimlane.Element(0).Lane.Shape = "red", sets the shape of the first lane within the pool to a CSS color "red"
 oSwimlane.Element(0).Phase.Shape = "red", sets the shape of the first phase within the pool to a CSS color "red"
 oSwimlane.Element(0).Lane.SetShape("red"), sets the shape of the first lane within the pool to a CSS color "red"
 oSwimlane.Element(0).Phase.SetShape("red"), sets the shape of the first phase within the pool to a CSS color "red"

where oSwimlane is an object of Swimlane type
Shape

Size :string

The Size property defines the size of the splitter (lane's height or phase's width). The Caption property specifies the ex-HTML caption of the lane or phase, while the Size property defines the lane's height or the phase's width. The Shape property defines the visual style of an individual lane or phase.
Type:
  • string
Since:
  • 1.8
Example
The following statements are equivalent:

 oSwimlane.Element(0).Lane.Size = 100, sets the height of the first lane within the pool to 100
 oSwimlane.Element(0).Phase.Size = 100, sets the width of the first phase within the pool to 100
 oSwimlane.Element(0).Lane.SetSize(100), sets the height of the first lane within the pool to 100
 oSwimlane.Element(0).Phase.SetSize(100), sets the width of the first phase within the pool to 100

where oSwimlane is an object of Swimlane type
Size

Methods