|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object java.awt.Component java.awt.Container javax.swing.JComponent javax.swing.JPanel bibliothek.extension.gui.dock.preference.AbstractPreferenceDialog<M>
M
- What kind of model this dialog can showpublic abstract class AbstractPreferenceDialog<M extends PreferenceModel>
An abstract dialog used to show the content of some PreferenceModel
. The
exact graphical user interface for the model depends on the subclass.
Note: clients using this panel have to call destroy()
. The only time destroy()
has
not to be called is if the dialog was shown using openDialog(Component, boolean)
and destroyOnClose
was set to true
.
Nested Class Summary |
---|
Nested classes/interfaces inherited from class javax.swing.JPanel |
---|
JPanel.AccessibleJPanel |
Nested classes/interfaces inherited from class javax.swing.JComponent |
---|
JComponent.AccessibleJComponent |
Nested classes/interfaces inherited from class java.awt.Container |
---|
Container.AccessibleAWTContainer |
Nested classes/interfaces inherited from class java.awt.Component |
---|
Component.AccessibleAWTComponent, Component.BaselineResizeBehavior, Component.BltBufferStrategy, Component.FlipBufferStrategy |
Field Summary |
---|
Fields inherited from class javax.swing.JComponent |
---|
accessibleContext, listenerList, TOOL_TIP_TEXT_KEY, ui, UNDEFINED_CONDITION, WHEN_ANCESTOR_OF_FOCUSED_COMPONENT, WHEN_FOCUSED, WHEN_IN_FOCUSED_WINDOW |
Fields inherited from class java.awt.Component |
---|
BOTTOM_ALIGNMENT, CENTER_ALIGNMENT, LEFT_ALIGNMENT, RIGHT_ALIGNMENT, TOP_ALIGNMENT |
Fields inherited from interface java.awt.image.ImageObserver |
---|
ABORT, ALLBITS, ERROR, FRAMEBITS, HEIGHT, PROPERTIES, SOMEBITS, WIDTH |
Constructor Summary | |
---|---|
|
AbstractPreferenceDialog(boolean destroyOnClose)
Creates a new dialog. |
protected |
AbstractPreferenceDialog(boolean init,
M model,
boolean destroyOnClose)
A constructor which does not initialize this dialog. |
|
AbstractPreferenceDialog(M model,
boolean destroyOnClose)
Creates a new dialog using the given model. |
Method Summary | |
---|---|
void |
close()
Makes the dialog invisible. |
void |
destroy()
Allows this dialog to free any resources that it used. |
void |
doApply()
Applies all changes but does not close the dialog. |
void |
doCancel()
Closes the dialog without saving and changes |
void |
doOk()
Applies all changes and closes the dialog. |
void |
doReset()
Resets all preferences to the value they had when the dialog opened |
protected abstract JComponent |
getContent()
Gets the component which will show the model
of this dialog. |
M |
getModel()
Gets the model which is shown on this dialog. |
protected void |
init(M model,
boolean destroyOnClose)
Creates the contents of this dialog. |
boolean |
isDestroyOnClose()
Tells whether destroy() is called automatically or not. |
void |
openDialog(Component owner,
boolean modal)
Opens the dialog (if not yet open) and lets the user make the changes of the preferences. |
void |
setDestroyOnClose(boolean destroyOnClose)
If set to true then destroy() is automatically called if this dialog is
closed |
void |
setModel(M model)
Sets the model of this dialog. |
protected abstract void |
setModelForContent(M model)
Informs subclasses that the model has changed and that they might setup the content again. |
Methods inherited from class javax.swing.JPanel |
---|
getAccessibleContext, getUI, getUIClassID, paramString, setUI, updateUI |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Constructor Detail |
---|
public AbstractPreferenceDialog(boolean destroyOnClose)
destroyOnClose
- if set to true
, then destroy()
is automatically called
if close()
is called. Clients have to call destroy()
manually if they are not
using openDialog(Component, boolean)
.public AbstractPreferenceDialog(M model, boolean destroyOnClose)
model
- the model to usedestroyOnClose
- if set to true
, then destroy()
is automatically called
if close()
is called. Clients have to call destroy()
manually if they are not
using openDialog(Component, boolean)
.protected AbstractPreferenceDialog(boolean init, M model, boolean destroyOnClose)
init(PreferenceModel, boolean)
to finish constructing this dialog.
init
- whether to call init(PreferenceModel, boolean)
.model
- the model to use, can be null
destroyOnClose
- if set to true
, then destroy()
is automatically called
if close()
is called. Clients have to call destroy()
manually if they are not
using openDialog(Component, boolean)
.Method Detail |
---|
protected void init(M model, boolean destroyOnClose)
model
- the model to use, can be null
destroyOnClose
- if set to true
, then destroy()
is automatically called
if close()
is called. Clients have to call destroy()
manually if they are not
using openDialog(Component, boolean)
.protected abstract JComponent getContent()
model
of this dialog.
protected abstract void setModelForContent(M model)
content
again.
model
- the new model, can be null
public void setModel(M model)
model
- the new modelpublic M getModel()
public void openDialog(Component owner, boolean modal)
PreferenceModel.read()
and
PreferenceModel.write()
to reset or to apply the changes of the user.
owner
- the owner of the dialogmodal
- whether the dialog should be modalpublic void doOk()
public void doApply()
public void doCancel()
public void doReset()
public void close()
public void destroy()
public boolean isDestroyOnClose()
destroy()
is called automatically or not.
setDestroyOnClose(boolean)
public void setDestroyOnClose(boolean destroyOnClose)
true
then destroy()
is automatically called if this dialog is
closed
destroyOnClose
- whether to free resources
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |