public interface IExtendedDialog
ExtendedDialog
class.Modifier and Type | Method and Description |
---|---|
ExtendedDialog |
configureContextsensitiveHelp(java.lang.String helpTopic,
boolean showHelpButton)
Configures how this dialog support for context sensitive help.
|
int |
getValue()
Retrieve the user choice after the dialog has been closed.
|
ExtendedDialog |
setButtonIcons(javax.swing.Icon... buttonIcons)
Allows decorating the buttons with icons.
|
ExtendedDialog |
setButtonIcons(java.lang.String... buttonIcons)
Convenience method to provide image names instead of images.
|
ExtendedDialog |
setCancelButton(java.lang.Integer... cancelButtonIdx)
Used in combination with toggle:
If the user presses 'cancel' the toggle settings are ignored and not saved to the pref
|
ExtendedDialog |
setContent(java.awt.Component content)
Sets the content that will be displayed in the message dialog.
|
ExtendedDialog |
setContent(java.awt.Component content,
boolean placeContentInScrollPane)
Sets the content that will be displayed in the message dialog.
|
ExtendedDialog |
setContent(java.lang.String message)
Sets the message that will be displayed.
|
ExtendedDialog |
setDefaultButton(int defaultButtonIdx)
Sets the button that will react to ENTER.
|
void |
setFocusOnDefaultButton(boolean focus)
Makes default button request initial focus or not.
|
ExtendedDialog |
setIcon(javax.swing.Icon icon)
Decorate the dialog with an icon that is shown on the left part of
the window area.
|
ExtendedDialog |
setIcon(int messageType)
Convenience method to allow values that would be accepted by
JOptionPane as messageType. |
ExtendedDialog |
setRememberWindowGeometry(java.lang.String pref,
WindowGeometry wg)
Call this if you want the dialog to remember the geometry (size and position) set by the user.
|
ExtendedDialog |
setToolTipTexts(java.lang.String... toolTipTexts)
Allows decorating the buttons with tooltips.
|
void |
setupDialog()
This is called by
showDialog() . |
ExtendedDialog |
showDialog()
Show the dialog to the user.
|
boolean |
toggleCheckState()
This function returns true if the dialog has been set to "do not show again"
|
ExtendedDialog |
toggleEnable(java.lang.String togglePref)
Calling this will offer the user a "Do not show again" checkbox for the
dialog.
|
ExtendedDialog setButtonIcons(javax.swing.Icon... buttonIcons)
buttonIcons
- The button iconsthis
ExtendedDialog setButtonIcons(java.lang.String... buttonIcons)
buttonIcons
- The button icon namesthis
ExtendedDialog setToolTipTexts(java.lang.String... toolTipTexts)
toolTipTexts
- the tool tip texts. Ignored, if null.this
ExtendedDialog setContent(java.awt.Component content)
content
- Any element that can be displayed in the message dialogthis
ExtendedDialog setContent(java.awt.Component content, boolean placeContentInScrollPane)
content
- Any element that can be displayed in the message dialogplaceContentInScrollPane
- if true, places the content in a JScrollPanethis
ExtendedDialog setContent(java.lang.String message)
message
- The text that should be shown to the userthis
ExtendedDialog setIcon(javax.swing.Icon icon)
JOptionPane
)icon
- The icon to displaythis
ExtendedDialog setIcon(int messageType)
JOptionPane
as messageType.messageType
- The JOptionPane
messageTypethis
ExtendedDialog showDialog()
getValue()
.this
int getValue()
ExtendedDialog.DialogClosedOtherwise
means the dialog has been closed otherwise.void setupDialog()
showDialog()
.
Only invoke from outside if you need to modify the contentPaneExtendedDialog setRememberWindowGeometry(java.lang.String pref, WindowGeometry wg)
null
or to an empty string to disable again.
By default, it's disabled.
Note: If you want to set the width of this dialog directly use the usual
setSize, setPreferredSize, setMaxSize, setMinSizepref
- The preference to save the dimension towg
- The default window geometry that should be used if no
existing preference is found (only takes effect if
pref
is not null or emptythis
ExtendedDialog toggleEnable(java.lang.String togglePref)
togglePref
- The preference to save the checkbox state tothis
ExtendedDialog setDefaultButton(int defaultButtonIdx)
defaultButtonIdx
- The button index (starts to 1)this
ExtendedDialog setCancelButton(java.lang.Integer... cancelButtonIdx)
cancelButtonIdx
- index of the button that stands for cancel, accepts multiple valuesthis
void setFocusOnDefaultButton(boolean focus)
focus
- true
to make default button request initial focusboolean toggleCheckState()
ExtendedDialog configureContextsensitiveHelp(java.lang.String helpTopic, boolean showHelpButton)
helpTopic
- the help topicshowHelpButton
- true, if the dialog displays a help buttonthis