Interface: ISimpleToolPaneOptions
A set of options which define the basic properties of a
window pane (or sub-pane) for a simple tool. This pane can
be a top level pane, or a child pane of the top level pane,
and is the content container for all of the UI controls used
by the editor tool. Each pane is uniquely identified by the
id property, and has a number of optional function
closures which are called at various points in the pane's
lifecycle. Note that instead of having a single onFinalize
function, panes implement a pair of onBeginFinalize and
onEndFinalize functions. This is to allow for the pane to
be partially constructed BEFORE any child panes are
constructed. Once all child panes have been fully finalized,
then the onEndFinalize function is called to allow the
pane to finalize itself.
Properties
childPaneInitiallyVisible?
optionalchildPaneInitiallyVisible:string
childPanes?
optionalchildPanes:ISimpleToolPaneOptions[]
childPanesMutuallyExclusive?
optionalchildPanesMutuallyExclusive:boolean
id
id:
string
onBeginFinalize()?
optionalonBeginFinalize: (pane) =>void
Parameters
| Parameter | Type |
|---|---|
pane | ISimpleToolPaneComponent |
Returns
void
onEndFinalize()?
optionalonEndFinalize: (pane) =>void
Parameters
| Parameter | Type |
|---|---|
pane | ISimpleToolPaneComponent |
Returns
void
onHide()?
optionalonHide: (pane) =>void
Parameters
| Parameter | Type |
|---|---|
pane | ISimpleToolPaneComponent |
Returns
void
onShow()?
optionalonShow: (pane) =>void
Parameters
| Parameter | Type |
|---|---|
pane | ISimpleToolPaneComponent |
Returns
void
onTeardown()?
optionalonTeardown: (pane) =>void
Parameters
| Parameter | Type |
|---|---|
pane | ISimpleToolPaneComponent |
Returns
void
titleAltText
titleAltText:
string
titleStringId?
optionaltitleStringId:string