public abstract class PamDialog
extends javax.swing.JDialog
Modifier and Type | Class and Description |
---|---|
class |
PamDialog.PopupListener
Only activated in the smruDev version to provide a quick
way of copying dialog displays for help file authoring.
|
Modifier and Type | Field and Description |
---|---|
static long |
serialVersionUID |
BOTTOM_ALIGNMENT, CENTER_ALIGNMENT, LEFT_ALIGNMENT, RIGHT_ALIGNMENT, TOP_ALIGNMENT
Constructor and Description |
---|
PamDialog(java.awt.Window parentFrame,
java.lang.String title,
boolean hasDefault)
Dialogs are always constructed with OK and Cancel buttons.
|
Modifier and Type | Method and Description |
---|---|
static void |
addComponent(javax.swing.JPanel panel,
java.awt.Component p,
java.awt.GridBagConstraints constraints)
add to a panel which must use GridBagLayout
|
abstract void |
cancelButtonPressed()
called when the cancel button is pressed before the
dialog closes.
|
void |
closeLater()
Reschedule closing of the window to happen
on the AWT thread using SwingUtilities.invokeLater(...)
|
void |
enableHelpButton(boolean helpOn) |
static java.lang.String |
formatDouble(double val)
Use the standard internal Double formatting to
print Double numbers with a minimum, but sensible number
of decimal places.
|
javax.swing.JPanel |
getButtonPanel() |
javax.swing.JButton |
getCancelButton()
getter for cancel button so that you
can change it's name from the default value
|
CancelObserver |
getCancelObserver() |
javax.swing.JButton |
getDefaultButton() |
javax.swing.JButton |
getHelpButton() |
java.lang.String |
getHelpPoint() |
javax.swing.JButton |
getOkButton()
getter for ok button so that you
can change it's name from the default value
|
abstract boolean |
getParams()
called when the Ok button is pressed.
|
java.lang.String |
getWarningTitle() |
boolean |
isSendGeneralSettingsNotification() |
boolean |
isWarnDefaultSetting() |
abstract void |
restoreDefaultSettings()
standard function which should us used to copy default parameters into
the dialog controls.
|
void |
restoreDefaultSettingsQ()
restore default setting ? Check with user before calling restoreDefaultSettings();
Thsi may be overridden if you want to ask a more complex question or offer
options at this point.
|
void |
setCancelObserver(CancelObserver cancelObserver) |
void |
setDialogComponent(javax.swing.JComponent component)
Used to set the main panel containing dialog controls -
|
static void |
setDoubleValue(javax.swing.JTextField textField,
java.lang.Double value,
java.lang.String format)
Set a Double value in a text field, setting appropriately to null
if the Double value is null
|
void |
setHelpPoint(java.lang.String helpPoint)
Sets the starting point for Java help.
|
void |
setSendGeneralSettingsNotification(boolean sendGeneralSettingsNotification)
Tell the Pamguard Controller to send a notification message around ALL
program modules, processes and data blocks indicating that some settings
have changed.
|
void |
setVisible(boolean visible) |
void |
setWarnDefaultSetting(boolean warnDefaultSetting) |
void |
setWarningTitle(java.lang.String warningTitle) |
boolean |
showQuestion(java.lang.String warningText)
Ask a yes no question and return true if yes was selected
|
boolean |
showQuestion(java.lang.String warningTitle,
java.lang.String warningText)
Ask a yes no question and return true if yes was selected
|
boolean |
showQuestion(java.awt.Window owner,
java.lang.String warningTitle,
java.lang.String warningText)
Ask a yes no question and return true if yes was selected
|
boolean |
showWarning(java.lang.String warningText)
Display a warning message with a default title
|
boolean |
showWarning(java.lang.String warningTitle,
java.lang.String warningText)
Display a warning message with given title and text
|
static boolean |
showWarning(java.awt.Window owner,
java.lang.String warningTitle,
java.lang.String warningText) |
getAccessibleContext, getContentPane, getDefaultCloseOperation, getGlassPane, getGraphics, getJMenuBar, getLayeredPane, getRootPane, getTransferHandler, isDefaultLookAndFeelDecorated, remove, repaint, setContentPane, setDefaultCloseOperation, setDefaultLookAndFeelDecorated, setGlassPane, setJMenuBar, setLayeredPane, setLayout, setTransferHandler, update
addNotify, getModalityType, getTitle, hide, isModal, isResizable, isUndecorated, setBackground, setModal, setModalityType, setOpacity, setResizable, setShape, setTitle, setUndecorated, show, toBack
addPropertyChangeListener, addPropertyChangeListener, addWindowFocusListener, addWindowListener, addWindowStateListener, applyResourceBundle, applyResourceBundle, createBufferStrategy, createBufferStrategy, dispose, getBackground, getBufferStrategy, getFocusableWindowState, getFocusCycleRootAncestor, getFocusOwner, getFocusTraversalKeys, getIconImages, getInputContext, getListeners, getLocale, getModalExclusionType, getMostRecentFocusOwner, getOpacity, getOwnedWindows, getOwner, getOwnerlessWindows, getShape, getToolkit, getType, getWarningString, getWindowFocusListeners, getWindowListeners, getWindows, getWindowStateListeners, isActive, isAlwaysOnTop, isAlwaysOnTopSupported, isAutoRequestFocus, isFocusableWindow, isFocusCycleRoot, isFocused, isLocationByPlatform, isOpaque, isShowing, isValidateRoot, pack, paint, postEvent, removeNotify, removeWindowFocusListener, removeWindowListener, removeWindowStateListener, reshape, setAlwaysOnTop, setAutoRequestFocus, setBounds, setBounds, setCursor, setFocusableWindowState, setFocusCycleRoot, setIconImage, setIconImages, setLocation, setLocation, setLocationByPlatform, setLocationRelativeTo, setMinimumSize, setModalExclusionType, setSize, setSize, setType, toFront
add, add, add, add, add, addContainerListener, applyComponentOrientation, areFocusTraversalKeysSet, countComponents, deliverEvent, doLayout, findComponentAt, findComponentAt, getAlignmentX, getAlignmentY, getComponent, getComponentAt, getComponentAt, getComponentCount, getComponents, getComponentZOrder, getContainerListeners, getFocusTraversalPolicy, getInsets, getLayout, getMaximumSize, getMinimumSize, getMousePosition, getPreferredSize, insets, invalidate, isAncestorOf, isFocusCycleRoot, isFocusTraversalPolicyProvider, isFocusTraversalPolicySet, layout, list, list, locate, minimumSize, paintComponents, preferredSize, print, printComponents, remove, removeAll, removeContainerListener, setComponentZOrder, setFocusTraversalKeys, setFocusTraversalPolicy, setFocusTraversalPolicyProvider, setFont, transferFocusDownCycle, validate
action, add, addComponentListener, addFocusListener, addHierarchyBoundsListener, addHierarchyListener, addInputMethodListener, addKeyListener, addMouseListener, addMouseMotionListener, addMouseWheelListener, bounds, checkImage, checkImage, contains, contains, createImage, createImage, createVolatileImage, createVolatileImage, disable, dispatchEvent, enable, enable, enableInputMethods, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, getBaseline, getBaselineResizeBehavior, getBounds, getBounds, getColorModel, getComponentListeners, getComponentOrientation, getCursor, getDropTarget, getFocusListeners, getFocusTraversalKeysEnabled, getFont, getFontMetrics, getForeground, getGraphicsConfiguration, getHeight, getHierarchyBoundsListeners, getHierarchyListeners, getIgnoreRepaint, getInputMethodListeners, getInputMethodRequests, getKeyListeners, getLocation, getLocation, getLocationOnScreen, getMouseListeners, getMouseMotionListeners, getMousePosition, getMouseWheelListeners, getName, getParent, getPeer, getPropertyChangeListeners, getPropertyChangeListeners, getSize, getSize, getTreeLock, getWidth, getX, getY, gotFocus, handleEvent, hasFocus, imageUpdate, inside, isBackgroundSet, isCursorSet, isDisplayable, isDoubleBuffered, isEnabled, isFocusable, isFocusOwner, isFocusTraversable, isFontSet, isForegroundSet, isLightweight, isMaximumSizeSet, isMinimumSizeSet, isPreferredSizeSet, isValid, isVisible, keyDown, keyUp, list, list, list, location, lostFocus, mouseDown, mouseDrag, mouseEnter, mouseExit, mouseMove, mouseUp, move, nextFocus, paintAll, prepareImage, prepareImage, printAll, remove, removeComponentListener, removeFocusListener, removeHierarchyBoundsListener, removeHierarchyListener, removeInputMethodListener, removeKeyListener, removeMouseListener, removeMouseMotionListener, removeMouseWheelListener, removePropertyChangeListener, removePropertyChangeListener, repaint, repaint, repaint, requestFocus, requestFocusInWindow, resize, resize, revalidate, setComponentOrientation, setDropTarget, setEnabled, setFocusable, setFocusTraversalKeysEnabled, setForeground, setIgnoreRepaint, setLocale, setMaximumSize, setName, setPreferredSize, show, size, toString, transferFocus, transferFocusBackward, transferFocusUpCycle
public static final long serialVersionUID
public PamDialog(java.awt.Window parentFrame, java.lang.String title, boolean hasDefault)
parentFrame
- owner frame - can be null, but preferably the owner frame of the
menu that calls this dialogtitle
- dialog titlehasDefault
- display a default buttonpublic javax.swing.JPanel getButtonPanel()
public void setDialogComponent(javax.swing.JComponent component)
component
- - usually a jPanelJPanel
public void setVisible(boolean visible)
setVisible
in class java.awt.Dialog
public void closeLater()
public abstract boolean getParams()
public abstract void cancelButtonPressed()
public java.lang.String getHelpPoint()
public void restoreDefaultSettingsQ()
public abstract void restoreDefaultSettings()
public void setHelpPoint(java.lang.String helpPoint)
helpPoint
- public void enableHelpButton(boolean helpOn)
public javax.swing.JButton getCancelButton()
public javax.swing.JButton getOkButton()
public static void addComponent(javax.swing.JPanel panel, java.awt.Component p, java.awt.GridBagConstraints constraints)
panel
- - a panel which must use GridBagLayoutp
- constraints
- public javax.swing.JButton getDefaultButton()
public javax.swing.JButton getHelpButton()
public void setSendGeneralSettingsNotification(boolean sendGeneralSettingsNotification)
sendGeneralSettingsNotification
- the sendGeneralSettingsNotification to setpublic boolean isSendGeneralSettingsNotification()
public java.lang.String getWarningTitle()
public void setWarningTitle(java.lang.String warningTitle)
public boolean showWarning(java.lang.String warningText)
warningText
- textpublic static boolean showWarning(java.awt.Window owner, java.lang.String warningTitle, java.lang.String warningText)
public boolean showWarning(java.lang.String warningTitle, java.lang.String warningText)
warningTitle
- title of warning dialogwarningText
- message of warning dialogpublic boolean showQuestion(java.lang.String warningText)
warningText
- text for optionpanepublic boolean showQuestion(java.lang.String warningTitle, java.lang.String warningText)
warningTitle
- title for dialogwarningText
- text for optionpanepublic boolean showQuestion(java.awt.Window owner, java.lang.String warningTitle, java.lang.String warningText)
owner
- parent windowwarningTitle
- title for dialogwarningText
- text for optionpanepublic static java.lang.String formatDouble(double val)
val
- value to formatpublic void setWarnDefaultSetting(boolean warnDefaultSetting)
warnDefaultSetting
- the warnDefaultSetting to setpublic boolean isWarnDefaultSetting()
public CancelObserver getCancelObserver()
public void setCancelObserver(CancelObserver cancelObserver)
cancelObserver
- the cancelObserver to setpublic static void setDoubleValue(javax.swing.JTextField textField, java.lang.Double value, java.lang.String format)
heading
- heading2
- string
-