|
|||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||
java.lang.Objectjava.awt.Component
java.awt.Container
javax.swing.JComponent
javax.swing.JPanel
org.formaria.swing.layer.LayerManager
org.formaria.swing.Page
org.formaria.swing.Dialog
public class Dialog
Provides support for Popups. This class extends Page giving a blank panel on which you can create custom dialogs. The dialog can be shown as a modal dialog which will block execution of the client code till the dialog is dismissed.
The Dialog is a form of page, however it contains a panel to which all the children are added. The panel is setup with a null layout as is normal and the pack method should be used to calculate the size of the dialog.
The Dialog is then added to a border layout contained in either a window or a dialog. This parent also contains the window decorations
.Copyright: Copyright (c) Formaria Ltd., 2008
License: see license.txt
| Nested Class Summary |
|---|
| Nested classes/interfaces inherited from class javax.swing.JPanel |
|---|
javax.swing.JPanel.AccessibleJPanel |
| Nested classes/interfaces inherited from class javax.swing.JComponent |
|---|
javax.swing.JComponent.AccessibleJComponent |
| Nested classes/interfaces inherited from class java.awt.Container |
|---|
java.awt.Container.AccessibleAWTContainer |
| Nested classes/interfaces inherited from class java.awt.Component |
|---|
java.awt.Component.AccessibleAWTComponent, java.awt.Component.BaselineResizeBehavior, java.awt.Component.BltBufferStrategy, java.awt.Component.FlipBufferStrategy |
| Nested classes/interfaces inherited from interface org.formaria.aria.PageSupport |
|---|
PageSupport.IDialog |
| Field Summary | |
|---|---|
protected boolean |
bIsModal
A flag indicating whether or not the dialog is modal |
static int |
BUTTON_SIZE
|
static int |
CANCEL_CLICKED
A state flag indicating that the CANCEL button was clicked |
static int |
CLOSE_CLICKED
A state flag indicating that the CLOSE button was clicked |
protected int |
closeButtonID
Was the close button clicked |
protected Panel |
contentPanel
The 'content' panel that holds the dialog's Page |
static int |
DEFAULT_PADDING
The default dialog padding. |
protected java.awt.Component |
focusComponent
The component that had focus prior to display of the dialog. |
protected static int |
lastReturnValue
The last return value |
static int |
NO_CLICKED
A state flag indicating that the NO button was clicked |
static int |
NOTHING_CLICKED_YET
A state flag indicating that no button clicked so far |
static int |
OK_CLICKED
A state flag indicating that the OK button was clicked |
protected int |
padding
The current dialog padding |
java.lang.Object |
returnObject
The return value, a user defined value |
protected int |
returnValue
The return value, indicating which button was clicked |
protected boolean |
saveOnClose
A flag indicating whether or not the dialog automatically saves its data when it is closed |
static boolean |
trueField
A boolean value used for checking a 'true' value |
| Fields inherited from class org.formaria.swing.Page |
|---|
adapter, componentFactory, pageHelper, pageMgr, project, rootModel |
| Fields inherited from class org.formaria.swing.layer.LayerManager |
|---|
BACKGROUND |
| 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 org.formaria.aria.PageSupport |
|---|
ACTIVATED, ANNOTATEDIMAGE, ARIA_AWT_PACKAGE, ARIA_HTML_PACKAGE, ARIA_SWING_PACKAGE, ARIA_SWT_PACKAGE, BORDER_LAYOUT, BOX_LAYOUT, BUTTON, CARD_LAYOUT, CHECK, COLUMN_LAYOUT, COMBO, CREATED, DEACTIVATED, DISCARDED, DISPLAYED, EDIT, FLOW_LAYOUT, GRID_LAYOUT, GRIDBAG_LAYOUT, GROUP, GUIDE_LAYOUT, HOTSPOTIMAGE, IMAGE, IMAGEMAP, LABEL, LAYER_LAYOUT, LIST, LOADED, MENU, MENUBAR, MENUITEM, METACONTENT, NULL_LAYOUT, PANEL, PASSWORD, RADIO, SCALE_LAYOUT, SCROLLABLEMETACONTENT, SCROLLPANE, SPLITPANE, SPRING_LAYOUT, TABLE, TABPANEL, TEXTAREA, UNKNOWN, UNKNOWN_PAGE_STATE, WMF |
| Fields inherited from interface java.awt.image.ImageObserver |
|---|
ABORT, ALLBITS, ERROR, FRAMEBITS, HEIGHT, PROPERTIES, SOMEBITS, WIDTH |
| Constructor Summary | |
|---|---|
Dialog()
Creates a new dialog and adds a content panel to the page. |
|
Dialog(boolean modal,
int pad)
Creates a new dialog and adds a content panel to the page. |
|
| Method Summary | |
|---|---|
java.awt.Component |
add(java.awt.Component c)
Add a component - this method should not normally be used. |
void |
cancelDlg()
Dismiss the dialog and discard the data. |
void |
closeDlg()
Close the dialog and restore focus |
java.lang.Object |
getContentPane()
The 'content' pane to which the pages are added |
protected java.awt.Component |
getFocusComponent(java.awt.Container cont)
Gets the component that owns the focus. |
static int |
getLastReturnValue()
Get the return value of the most recently dismissed dialog |
java.awt.Dimension |
getMinimumSize()
Get the minimum layout size |
java.awt.Dimension |
getPreferredSize()
Get the preferred layout size |
java.lang.Object |
getReturnObject()
Provides access to an object representing the state of the dialog when it was closed. |
void |
pack()
Size the dialog to hold the largest components (i.e. |
void |
pageCreated()
Overload the Page XCreated event and set the caption of the dialog from the title attribute. |
void |
setBackground(java.awt.Color c)
Set the background color |
void |
setCaption(java.lang.String c)
Set the dialog caption/title |
void |
setFont(java.awt.Font f)
|
void |
setForeground(java.awt.Color c)
|
void |
setHideFrame(boolean hide)
Set flag to indicate whether to paint the border and add the title panel |
void |
setLayout(java.awt.LayoutManager lm)
Set the layout manager for the content pane |
void |
setLocation(int x,
int y)
Set the location of the dialog window |
void |
setLocation(java.awt.Point location)
Set the location of the dialog window |
void |
setModal(boolean modal)
Set the dialog to be modal or non-modal |
void |
setResizable(boolean state)
Set the resizable property. |
void |
setSaveOnClose(boolean save)
Set the save on close option |
void |
setSize(int width,
int height)
Set the size of the dialog and centres it within the parent. |
void |
setUseNativeHeaders(boolean bh)
Set the dialog to use the native platform decorations (title bar and borders). |
int |
showDialog(java.lang.Object owner)
Shows the dialog. |
int |
showDialog(java.lang.Object cbParent,
java.lang.String cb)
Shows the dialog. |
int |
showDialog(java.lang.Object owner,
java.lang.String title,
java.awt.Point location)
Shows the dialog. |
void |
showModalWindow(java.awt.Component contents)
Show the dialog ina modal way |
boolean |
wasMouseClicked()
A utility method used to determine if the last event corrseponds to a mouse click. |
| Methods inherited from class org.formaria.swing.layer.LayerManager |
|---|
add, add, add, add, addLayer, deleteLayer, getActiveLayer, getActiveLayerIndex, getComponent, getInputContext, getLayer, getLayer, getLayerNames, isEnabled, isFocusable, isLayerEnabled, isLayerEnabled, isLayerVisible, moveLayerDown, moveLayerUp, paintChildren, setActiveLayer, setBounds, setLayerEnabled, setLayerName, setLayerVisible, updateLayerSizes |
| Methods inherited from class javax.swing.JPanel |
|---|
getAccessibleContext, getUI, getUIClassID, paramString, setUI, updateUI |
| Methods inherited from class javax.swing.JComponent |
|---|
addAncestorListener, addVetoableChangeListener, computeVisibleRect, contains, createToolTip, disable, enable, firePropertyChange, firePropertyChange, firePropertyChange, fireVetoableChange, getActionForKeyStroke, getActionMap, getAlignmentX, getAlignmentY, getAncestorListeners, getAutoscrolls, getBaseline, getBaselineResizeBehavior, getBorder, getBounds, getClientProperty, getComponentGraphics, getComponentPopupMenu, getConditionForKeyStroke, getDebugGraphicsOptions, getDefaultLocale, getFontMetrics, getHeight, getInheritsPopupMenu, getInputMap, getInputMap, getInputVerifier, getInsets, getInsets, getListeners, getLocation, getMaximumSize, getNextFocusableComponent, getPopupLocation, getRegisteredKeyStrokes, getRootPane, getSize, getToolTipLocation, getToolTipText, getToolTipText, getTopLevelAncestor, getTransferHandler, getVerifyInputWhenFocusTarget, getVetoableChangeListeners, getVisibleRect, getWidth, getX, getY, grabFocus, isDoubleBuffered, isLightweightComponent, isManagingFocus, isOpaque, isOptimizedDrawingEnabled, isPaintingForPrint, isPaintingTile, isRequestFocusEnabled, isValidateRoot, paintBorder, paintComponent, paintImmediately, paintImmediately, print, printAll, printBorder, printChildren, printComponent, processComponentKeyEvent, processKeyBinding, processKeyEvent, processMouseEvent, processMouseMotionEvent, putClientProperty, registerKeyboardAction, registerKeyboardAction, removeAncestorListener, removeNotify, removeVetoableChangeListener, repaint, repaint, requestDefaultFocus, requestFocus, requestFocus, requestFocusInWindow, requestFocusInWindow, resetKeyboardActions, reshape, revalidate, scrollRectToVisible, setActionMap, setAlignmentX, setAlignmentY, setAutoscrolls, setBorder, setComponentPopupMenu, setDebugGraphicsOptions, setDefaultLocale, setDoubleBuffered, setEnabled, setFocusTraversalKeys, setInheritsPopupMenu, setInputMap, setInputVerifier, setMaximumSize, setMinimumSize, setNextFocusableComponent, setOpaque, setPreferredSize, setRequestFocusEnabled, setToolTipText, setTransferHandler, setUI, setVerifyInputWhenFocusTarget, setVisible, unregisterKeyboardAction |
| Methods inherited from class java.awt.Container |
|---|
addContainerListener, addImpl, addPropertyChangeListener, addPropertyChangeListener, applyComponentOrientation, areFocusTraversalKeysSet, countComponents, deliverEvent, doLayout, findComponentAt, findComponentAt, getComponentAt, getComponentAt, getComponentCount, getComponents, getComponentZOrder, getContainerListeners, getFocusTraversalKeys, getFocusTraversalPolicy, getLayout, getMousePosition, insets, invalidate, isAncestorOf, isFocusCycleRoot, isFocusCycleRoot, isFocusTraversalPolicyProvider, isFocusTraversalPolicySet, list, list, locate, minimumSize, paintComponents, preferredSize, printComponents, processContainerEvent, processEvent, remove, remove, removeAll, removeContainerListener, setComponentZOrder, setFocusCycleRoot, setFocusTraversalPolicy, setFocusTraversalPolicyProvider, transferFocusBackward, transferFocusDownCycle, validate, validateTree |
| Methods inherited from class java.awt.Component |
|---|
action, add, addComponentListener, addFocusListener, addHierarchyBoundsListener, addHierarchyListener, addInputMethodListener, addKeyListener, addMouseListener, addMouseMotionListener, addMouseWheelListener, bounds, checkImage, checkImage, coalesceEvents, contains, createImage, createImage, createVolatileImage, createVolatileImage, disableEvents, dispatchEvent, enable, enableEvents, enableInputMethods, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, getBackground, getBounds, getColorModel, getComponentListeners, getComponentOrientation, getCursor, getDropTarget, getFocusCycleRootAncestor, getFocusListeners, getFocusTraversalKeysEnabled, getFont, getForeground, getGraphicsConfiguration, getHierarchyBoundsListeners, getHierarchyListeners, getIgnoreRepaint, getInputMethodListeners, getInputMethodRequests, getKeyListeners, getLocale, getLocation, getLocationOnScreen, getMouseListeners, getMouseMotionListeners, getMousePosition, getMouseWheelListeners, getName, getParent, getPeer, getPropertyChangeListeners, getPropertyChangeListeners, getSize, getToolkit, getTreeLock, gotFocus, handleEvent, hasFocus, hide, imageUpdate, inside, isBackgroundSet, isCursorSet, isDisplayable, isFocusOwner, isFocusTraversable, isFontSet, isForegroundSet, isLightweight, isMaximumSizeSet, isMinimumSizeSet, isPreferredSizeSet, isShowing, isValid, isVisible, keyDown, keyUp, list, list, list, location, lostFocus, mouseDown, mouseDrag, mouseEnter, mouseExit, mouseMove, mouseUp, move, nextFocus, paintAll, postEvent, prepareImage, prepareImage, processComponentEvent, processFocusEvent, processHierarchyBoundsEvent, processHierarchyEvent, processInputMethodEvent, processMouseWheelEvent, remove, removeComponentListener, removeFocusListener, removeHierarchyBoundsListener, removeHierarchyListener, removeInputMethodListener, removeKeyListener, removeMouseListener, removeMouseMotionListener, removeMouseWheelListener, removePropertyChangeListener, removePropertyChangeListener, repaint, repaint, repaint, resize, resize, setBounds, setComponentOrientation, setCursor, setDropTarget, setFocusable, setFocusTraversalKeysEnabled, setIgnoreRepaint, setLocale, setName, setSize, show, show, size, toString, transferFocus, transferFocusUpCycle |
| Methods inherited from class java.lang.Object |
|---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
| Methods inherited from interface org.formaria.aria.PersistentState |
|---|
restoreState, saveState |
| Field Detail |
|---|
public static final int BUTTON_SIZE
public static final boolean trueField
public static final int DEFAULT_PADDING
public static final int NOTHING_CLICKED_YET
public static final int OK_CLICKED
public static final int CANCEL_CLICKED
public static final int CLOSE_CLICKED
public static final int NO_CLICKED
protected boolean bIsModal
protected boolean saveOnClose
protected int returnValue
protected static int lastReturnValue
public java.lang.Object returnObject
protected Panel contentPanel
protected int padding
protected java.awt.Component focusComponent
protected int closeButtonID
| Constructor Detail |
|---|
public Dialog()
public Dialog(boolean modal,
int pad)
modal - true for a modal dialogpad - the amount of padding in pixels| Method Detail |
|---|
public void pageCreated()
pageCreated in interface PageSupportpageCreated in class Pagepublic java.awt.Component add(java.awt.Component c)
add in interface ILayerManageradd in class LayerManagerc - the component to add
Container.addImpl(java.awt.Component, java.lang.Object, int),
Container.validate(),
JComponent.revalidate()public void setLayout(java.awt.LayoutManager lm)
setLayout in class LayerManagerlm - the layout managerContainer.doLayout(),
Container.getLayout()public void setBackground(java.awt.Color c)
PageSupport
setBackground in interface PageSupportsetBackground in class javax.swing.JComponentc - The colorpublic void setForeground(java.awt.Color c)
setForeground in class javax.swing.JComponentpublic void setHideFrame(boolean hide)
hide - if set to true don't add the title panel and don't paint the
borderpublic void setFont(java.awt.Font f)
setFont in class javax.swing.JComponentpublic static int getLastReturnValue()
public java.lang.Object getContentPane()
getContentPane in interface ContentPanepublic void pack()
pack in interface DialogSupportpublic void setCaption(java.lang.String c)
setCaption in interface DialogSupportc - the new captionpublic java.awt.Dimension getMinimumSize()
getMinimumSize in class javax.swing.JComponentpublic java.awt.Dimension getPreferredSize()
getPreferredSize in class javax.swing.JComponentpublic void setUseNativeHeaders(boolean bh)
bh - true to use native decorations.public void setModal(boolean modal)
modal - true for a modal dialogpublic void setSaveOnClose(boolean save)
save - true to save the data when the dialog is closed or dismissed, false to
discard the data.public void setResizable(boolean state)
state - true for a resizable dialogsetUseNativeHeaderspublic void cancelDlg()
public void closeDlg()
public int showDialog(java.lang.Object owner,
java.lang.String title,
java.awt.Point location)
owner - The container to which the dialog is added.title - The dialog title/captionlocation - The location on screen to show the dialog
public int showDialog(java.lang.Object cbParent,
java.lang.String cb)
cbParent - The parent/owner for purposes of a callback.cb - The name of a callback method in the parent (or null) to be invoked when the dialog is dismissed.public int showDialog(java.lang.Object owner)
showDialog in interface DialogSupportowner - The container to which the dialog is added.
public void setSize(int width,
int height)
setSize in interface ILayerManagersetSize in interface PageSupportsetSize in class java.awt.Componentwidth - The new widthheight - The new height#getSize,
#setBoundspublic void setLocation(java.awt.Point location)
setLocation in class java.awt.Componentlocation - the point on screen at which the dialog is to be shown.
public void setLocation(int x,
int y)
setLocation in interface PageSupportsetLocation in class java.awt.Componentx - the x coordinate, or -1 for ignore/default location, -2 for centered on screeny - the y coordinateprotected java.awt.Component getFocusComponent(java.awt.Container cont)
cont - the container to be checked for focus.
public java.lang.Object getReturnObject()
public boolean wasMouseClicked()
wasMouseClicked in interface PageSupportwasMouseClicked in class Pagepublic void showModalWindow(java.awt.Component contents)
contents - The dialog's content
|
|||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||