class PrefsPane

->jsx3.lang.Object

->jsx3.amp.util.PrefsPane

All Implemented Interfaces:

jsx3.util.EventDispatcher

class PrefsPane
extends jsx3.lang.Object

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

Field Summary
static String	DIRTIED Event subject published when the state of a preference pane is dirtied.
static String	SAVED Event subject published when a preference pane is saved.

Constructor Summary
void	init(ext : jsx3.amp.Ext, obj : jsx3.amp.XML) The instance initializer.

Method Summary
String	getDescription() Returns the description of this pane.
jsx3.app.Model	getFirstResponder() Returns the object in the UI of this pane that should get focus when this pane is first revealed.
String	getImage() Returns the resolved path of the image of this pane.
Object	getProperty(strId : String) Returns an arbitrary property of this pane.
String	getTitle() Returns the title of this pane.
jsx3.app.Model	getUI() Returns the root component of this pane once it is rendered.
boolean	isDirty() Returns whether this pane has unsaved changes.
jsx3.$AsyncRV	save() Saves the state of this pane.
void	setDirty(bDirty : boolean) Sets whether this pane has unsaved changes.
void	setProperty(strId : String, objValue : Object) Sets an arbitrary property of this pane.

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

DIRTIED

static String DIRTIED

Event subject published when the state of a preference pane is dirtied.

SAVED

static String SAVED

Event subject published when a preference pane is saved.

Constructor Detail

init

void init(ext : jsx3.amp.Ext, obj : jsx3.amp.XML)

The instance initializer. The obj parameter must define an attribute, resource, which is the name of an XML resource of ext. This resource will be loaded as the UI component of this pane. The root object of this component file may define the following methods:

getFirstResponder() : jsx3.app.Model — returns the object that should be focused when the pane is revealed.
loadPrefs() : void — restores the state of the pane before it is revealed.
savePrefs() : void | Object{title, message} — saves the state of the pane and optionally returns a title and message to be shown in an alert dialog.

Parameters:

ext – the AMP extension declaring this pane.

obj – the XML declaration of the extension.

Method Detail

getDescription

String getDescription()

Returns the description of this pane.

Returns:

getFirstResponder

jsx3.app.Model getFirstResponder()

Returns the object in the UI of this pane that should get focus when this pane is first revealed. This method delegates to the method getFirstResponder() of the root UI component for this pane, if that method is defined.