Public Member Functions | |
void | commitChanges () |
Try to save changes in domain configuration. | |
void | cleanAllFiles () |
Function will clean all files in the domain. | |
void | registerCommand (in AString command, in AString text) |
Register new command. | |
void | unregisterCommand (in AString command) |
Unregister existing command. | |
void | registerActionObjectListener (in AString objectType, in tmozIActionObjectListener listener) |
Register new action object listener. | |
void | unregisterActionObjectListener (in tmozIActionObjectListener listener) |
Unregister action object listener. | |
Public Attributes | |
readonly attribute tmozIApplication | application |
Application. | |
const long | DOMAIN_STATUS_INACTIVE = 0 |
Constant for inactive domain. | |
const long | DOMAIN_STATUS_STARTING = 1 |
Constant for domain being activated. | |
const long | DOMAIN_STATUS_ACTIVATED = 2 |
Constant for activated domain. | |
readonly attribute long | status |
Domain Status. | |
readonly attribute tmozIDomainConfiguration | configuration |
Domain configuration. | |
readonly attribute tmozIFrame | mainFrame |
Main frame. | |
readonly attribute tmozIDomainComponentManager | componentManager |
Component manager. |
Domain object provides access to the domain specific data and also to the user interface of the running Tahiti. It is important to check state of domain before accessing UI functions.
Domain can be in 1 of 3 states:
0
inactive - without UI - only some basic configuration is available 1
activating - domain is about to activate. User should wait till domain become inactive or activated 2
activated - domain is active with UI void cleanAllFiles | ( | ) |
Function will clean all files in the domain.
All domain specific files will be deleted except domain.xml. Function can be called only if domain is inactive.
void commitChanges | ( | ) |
Try to save changes in domain configuration.
This method can be called only on inactive domain. Method will save configuration to the domain.xml.
void registerActionObjectListener | ( | in AString | objectType, | |
in tmozIActionObjectListener | listener | |||
) |
Register new action object listener.
Registered listener will receive notifications about received action objects (tmozIActionObject).
objectType | Type of the objects accepted by listener. | |
listener | Listener to be registered. |
void registerCommand | ( | in AString | command, | |
in AString | text | |||
) |
Register new command.
Register new command as native Tahiti command. This command have to be handle by one of the components.
command | Command id | |
text | User visible command description |
void unregisterActionObjectListener | ( | in tmozIActionObjectListener | listener | ) |
Unregister action object listener.
Unregister action object listener from the domain. Listener will not receive any more notifications.
If one listener is registered for more types it will be unregistered for all types.
void unregisterCommand | ( | in AString | command | ) |
Unregister existing command.
Unregister command from the Tahiti. Command had to be registered using registerCommand().
command | Command id |
readonly attribute tmozIApplication application |
Application.
This is main application object
readonly attribute tmozIDomainComponentManager componentManager |
Component manager.
Manager for domain specific components. These components are available only within this domain.
readonly attribute tmozIDomainConfiguration configuration |
Domain configuration.
Domain configuration object.
readonly attribute tmozIFrame mainFrame |
Main frame.
Main frame for the domain. This exists while domain is in active.
readonly attribute long status |
Domain Status.
This is domain status
0
inactive - without UI - only some basic configuration is available 1
activating - domain is about to activate. User should wait till domain become inactive or activated 2
activated - domain is active with UI