|
|
|||||
| Package com.dassault_systemes.catjdialog |
Class CATOptionPanel
|
| Class Hierarchy |
java.lang.Object
|
+-com.dassault_systemes.catjdialog.CATCallbackSource
|
+-com.dassault_systemes.catjdialog.CATDialog
|
+-com.dassault_systemes.catjdialog.CATOptionPanel
| Class Location |
| Class Description |
public class CATOptionPanel
The option panel graphical component.
Here are some rules:
CATOptionPanel fires an 'initialize' notification when it's initialized with a CATSetting.See the CAA technical article "Creating Administration Commands" for details.
<optionpanel_path>.Title entry.
You may also set it programmatically using setTitle().
All Implemented Interfaces: CATITitleDialog
| Field Summary |
| Constructor Summary |
| CATOptionPanel(CATDialog iParent, String iName)
Creates an option panel with the specified parent and name. |
| Method Summary |
| public CATDialog | getContent()
Returns the child component that is the content of the option panel. |
| public CATNotification | getFlushChangesNotification()
Returns the flush changes notification. |
| public CATNotification | getInitializeNotification()
Returns the initialize notification. |
| public CATOptionRepository | getOptionRepository(String iName)
Returns an option repository from name. |
| public CATSetting | getSetting()
Returns the CATSetting repository managed by the 'Administration & User Preferences' command. |
| public String | getTitle()
Returns the option panel's title. |
| public void | registerToAfterSubmit(String iRegistrationID, Object iListener, String iMethod, Object iData)
Registers to 'after submit' notification. |
| public void | registerToBeforeSubmit(String iRegistrationID, Object iListener, String iMethod, Object iData)
Registers to 'before submit' notification. |
| public void | setOptionRepository(String iName, CATOptionRepository iRepository)
Defines an option repository. |
| public void | setTitle(String iTitle)
Sets the option panel's title. |
| public void | unRegisterToAfterSubmit(String iRegistrationID, Object iListener, String iMethod, Object iData)
Unregisters to 'after submit' notification. |
| public void | unRegisterToBeforeSubmit(String iRegistrationID, Object iListener, String iMethod, Object iData)
Unregisters to 'before submit' notification. |
| Field Detail |
| Constructor Detail |
CATOptionPanel(CATDialog iParent, String iName)
Creates an option panel with the specified parent and name.
iParentiName| Method Detail |
public CATDialog getContent()
Returns the child component that is the content of the option panel.
public CATNotification getFlushChangesNotification()
Returns the flush changes notification.
The option panel fires this notification to warn that setting changes should be logged into the CATSetting repository
public CATNotification getInitializeNotification()
Returns the initialize notification.
This notification is sent when the option panel has been initialized (has a CATSetting)
public CATOptionRepository getOptionRepository(String iName)
Returns an option repository from name.
This is an object able to manage settings from another source than CATSetting.
iName
public CATSetting getSetting()
Returns the CATSetting repository managed by the 'Administration & User Preferences' command.
public String getTitle()
Returns the option panel's title.
Returns the programmatic value if setTitle() has been called,
or tries to retrieve its title from the associated message catalog file
(<optionpanel_path>.Title entry).
public void registerToAfterSubmit(String iRegistrationID, Object iListener, String iMethod, Object iData)
Registers to 'after submit' notification.
This notification is fired right after saving the CATSetting repository
(when the user presses the 'Ok' or the 'Apply' button).
This is to allow controllers to store their own settings in an
other place than CATSetting.
iRegistrationIDiListeneriMethodiData
public void registerToBeforeSubmit(String iRegistrationID, Object iListener, String iMethod, Object iData)
Registers to 'before submit' notification.
This notification is fired right before saving the CATSetting repository
(when the user presses the 'Ok' or the 'Apply' button).
This is to allow controllers to store their own settings in an
other place than CATSetting.
iRegistrationIDiListeneriMethodiData
public void setOptionRepository(String iName, CATOptionRepository iRepository)
Defines an option repository.
This is an object able to manage settings from another source than CATSetting.
iNameiRepository
public void setTitle(String iTitle)
Sets the option panel's title.
Calling this method sets programmatically the title. This should
be reserved for cases where the title can only be determined by dynamic
means.
The standard way of defining components messages is using CATNls catalog
files (supports NLS).
iTitle
public void unRegisterToAfterSubmit(String iRegistrationID, Object iListener, String iMethod, Object iData)
Unregisters to 'after submit' notification.
iRegistrationIDiListeneriMethodiData
public void unRegisterToBeforeSubmit(String iRegistrationID, Object iListener, String iMethod, Object iData)
Unregisters to 'before submit' notification.
iRegistrationIDiListeneriMethodiData