new PhaseOptions()
The exontrol.Surface.PhaseOptions class holds all options a phase can display or own. You can use the OnCreatePhase(oPhaseOpts) method of exontrol.Swimlane.Pools class to customize the phase's options once the user creates a new phase by drag and drop. The oPhaseOpts parameter is an object of exontrol.Surface.PhaseOptions type.
- Since:
- 5.2
Members
(static) caption :string
The caption field defines the caption of the phase. You can use the caption field to set the phase's caption once the phase is created by drag and drop.
Type:
- string
Example
"New Phase" {string}, sets the caption of the phase to "New Phase"(static) index :number
The index field specifies the index of the phase. The index is read-only.
Type:
- number
Example
console.log(oPhaseOpts.index), displays the index of the phase within the pool(static) phases :object
The phases field defines the pool's phases. The phases field is read-only.
Type:
- object
Example
console.log(oPhaseOpts.phases.content), displays all phases of the pool that owns the phase, including the current phase(static) pool :Pool
The pool field indicates the owner pool of the phase. The pool field is read-only.
Type:
Example
console.log(oPhaseOpts.pool.Key), displays the key of the pool that owns the phase(static) shape :any
The shape field specifies the shape to be applied on the phase. You can use the shape field to set the phase's shape once the phase is created by drag and drop.
The shape can be any of the following:
- {string}, specifies the shape of the phase as a CSS-color, a predefined shape such as "FrameSel" member of exontrol.Shapes
- {object}, specifies an object of {normal,hover,click,disabled} type. The normal,hover,click and disabled are objects of exontrol.Def.Shape type
Type:
- any
Example
"red" {string}, sets the shape of the phase to red color
"FrameSel" {string}, sets the shape of the phase to "FrameSel"(static) size :number
The size field indicates the size (in pixels) of the phase or null if the [size] flag is missing. The size field is read-only.
Type:
- number