class Prefs

->jsx3.lang.Object

->jsx3.amp.util.Prefs

All Implemented Interfaces:

jsx3.util.EventDispatcher

A preferences panel. Provided by the jsx3.amp.util.prefspanel plug-in.

Field Summary
static String	SAVE Event subject published when a preferences panel is saved.
static String	SWITCH Event subject published when the active pane of a preferences panel is changed.
static String	UNLOAD Event subject published when a preferences panel is closed.

Constructor Summary
void	init() The instance initializer.

Method Summary
void	addPane(objPane : jsx3.amp.util.PrefsPane) Adds a prefs pane to this controller.
void	apply() Saves the state of the current pane.
boolean	getCollapse() Returns whether to collapse the left side pane list.
void	renderIn(objParent : jsx3.gui.Model, intPaneToShow : int \| jsx3.amp.util.PrefsPane) Renders the preferences panel in objParent.
void	save() Saves the state of the current pane and closes this panel.
void	setCollapse(bCollapse : boolean) Sets whether to collapse the left side pane list.
jsx3.$AsyncRV	showPane(objPane : jsx3.amp.util.PrefsPane \| int, bForce : boolean) Displays a prefs pane in the edit area.
jsx3.$AsyncRV	unload(bForce : boolean) Removes this preferences panel from the view.

Methods Inherited From jsx3.util.EventDispatcher
publish, subscribe, unsubscribe, unsubscribeAll

Methods Inherited From jsx3.lang.Object
clone, equals, eval, getClass, getInstanceOf, getInstanceOfClass, getInstanceOfPackage, instanceOf, isInstanceOf, isSubclassOf, jsxmix, jsxsuper, jsxsupermix, setInstanceOf, toString

Field Detail

SAVE

static String SAVE

Event subject published when a preferences panel is saved.

SWITCH

static String SWITCH

Event subject published when the active pane of a preferences panel is changed.

UNLOAD

static String UNLOAD

Event subject published when a preferences panel is closed.

Constructor Detail

init

void init()

The instance initializer.

Method Detail

addPane

void addPane(objPane : jsx3.amp.util.PrefsPane)

Adds a prefs pane to this controller. This method may be called either before or after renderIn() has been called.

Parameters:

objPane – the pane to add.

apply

void apply()

Saves the state of the current pane.

getCollapse

boolean getCollapse()

Returns whether to collapse the left side pane list.

Returns:

renderIn

void renderIn(objParent : jsx3.gui.Model, intPaneToShow : int | jsx3.amp.util.PrefsPane)

Renders the preferences panel in objParent.

Parameters:

objParent – the parent to load this panel into.

intPaneToShow – optionally, the pane to reveal initially.

save

void save()

Saves the state of the current pane and closes this panel.

setCollapse

void setCollapse(bCollapse : boolean)

Sets whether to collapse the left side pane list.

Parameters:

bCollapse –

showPane

asynchronous jsx3.$AsyncRV showPane(objPane : jsx3.amp.util.PrefsPane | int, bForce : boolean)

Displays a prefs pane in the edit area. Unloads the current prefs pane if necessary. If the current prefs pane is dirty, the user will be prompted to save or discard changes before the prefs pane is switched.

The asynchronous return value is true only if the pane was shown successfully.

Parameters:

objPane – the pane to switch to.

bForce – if true, the current pane is unloaded without saving changes.

Returns:

unload

asynchronous jsx3.$AsyncRV unload(bForce : boolean)

Removes this preferences panel from the view.

The asynchronous return value is true only if the preferences panel was unloaded successfully.

Parameters:

bForce – whether to force the removal even if there are unsaved changes.