|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object jap.AbstractJAPConfModule
public abstract class AbstractJAPConfModule
This is the generic implementation for a JAP configuration module.
Nested Class Summary | |
---|---|
protected class |
AbstractJAPConfModule.FontSizeObserver
Observes changes of the font size. |
private class |
AbstractJAPConfModule.RootPanelAncestorListener
Helper class for creating a onRootPanelShown call when the root panel (the whole configuration tab of this module) is coming to foreground. |
Field Summary | |
---|---|
private AWTUpdateQueue |
AWT_UPDATE_QUEUE
|
protected java.lang.Object |
LOCK_OBSERVABLE
|
private boolean |
m_bObserversInitialised
|
private javax.swing.JPanel |
m_rootPanel
This stores the root panel of this configuration tab. |
protected IJAPConfSavePoint |
m_savePoint
The savepoint for this module. |
Constructor Summary | |
---|---|
protected |
AbstractJAPConfModule(IJAPConfSavePoint a_moduleSavePoint)
This is the constructor of AbstractJAPConfModule. |
Method Summary | |
---|---|
void |
cancelPressed()
This method is called every time the user presses the "Cancel" button. |
void |
createSavePoint()
This will create a new savepoint with the current configuration. |
static java.awt.GridBagConstraints |
createTabbedRootPanelContraints()
Creates constraints for an equal alignment of a root panel with tabs. |
void |
fontSizeChanged(JAPModel.FontResize a_fontResize,
javax.swing.JLabel a_dummyLabel)
May contain some logic that is executed when the font size changes. |
java.awt.Component |
getHelpExtractionDisplayContext()
|
javax.swing.JPanel |
getRootPanel()
This returns the root panel for this configuration module. |
abstract java.lang.String |
getTabTitle()
This method must be implemented by the children of AbstractJAPConfModule and returns the title for this configuration tab. |
protected boolean |
initObservers()
All observables that are observed by this object MUST be registered here. |
boolean |
okPressed()
This method is called every time the user presses the "OK" button. |
protected void |
onCancelPressed()
This method can be overwritten by the children of AbstractJAPConfModule. |
protected boolean |
onOkPressed()
This method can be overwritten by the children of AbstractJAPConfModule. |
protected void |
onResetToDefaultsPressed()
This method can be overwritten by the children of AbstractJAPConfModule. |
protected void |
onRootPanelShown()
This method can be overwritten by the children of AbstractJAPConfModule. |
protected void |
onUpdateValues()
This method can be overwritten by the children of AbstractJAPConfModule. |
abstract void |
recreateRootPanel()
This method must be implemented by the children of AbstractJAPConfModule. |
void |
resetToDefaultsPressed()
This method is called every time the user presses the "Reset to defaults" button. |
void |
updateValues(boolean a_bSync)
This method is called, if something on the configuration data has changed and the module shall update its GUI. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Methods inherited from interface gui.JAPHelpContext.IHelpContext |
---|
getHelpContext |
Field Detail |
---|
private final AWTUpdateQueue AWT_UPDATE_QUEUE
private javax.swing.JPanel m_rootPanel
protected IJAPConfSavePoint m_savePoint
private boolean m_bObserversInitialised
protected final java.lang.Object LOCK_OBSERVABLE
Constructor Detail |
---|
protected AbstractJAPConfModule(IJAPConfSavePoint a_moduleSavePoint)
a_moduleSavePoint
- The savepoint for this module. If you supply null, there is no
possibility for creating savepoints for this module. Also the
default configuration for this module cannot be restored auto-
matically.Method Detail |
---|
public static java.awt.GridBagConstraints createTabbedRootPanelContraints()
public abstract java.lang.String getTabTitle()
public abstract void recreateRootPanel()
public final javax.swing.JPanel getRootPanel()
public final void createSavePoint()
public final boolean okPressed()
public void fontSizeChanged(JAPModel.FontResize a_fontResize, javax.swing.JLabel a_dummyLabel)
a_fontResize
- the resize factora_dummyLabel
- a label to get the current JLabel font size frompublic final void cancelPressed()
public final void resetToDefaultsPressed()
public final void updateValues(boolean a_bSync)
a_bSync
- if the current thread should wait until the operation is performedprotected void onRootPanelShown()
protected boolean onOkPressed()
protected void onCancelPressed()
protected void onResetToDefaultsPressed()
protected void onUpdateValues()
protected boolean initObservers()
public java.awt.Component getHelpExtractionDisplayContext()
getHelpExtractionDisplayContext
in interface JAPHelpContext.IHelpContext
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |