org.openbp.jaspira.gui.plugin
Class PluginDialog

java.lang.Object
  java.awt.Component
      java.awt.Container
          java.awt.Window
              java.awt.Dialog
                  javax.swing.JDialog
                      org.openbp.jaspira.gui.plugin.PluginDialog

All Implemented Interfaces:

java.awt.image.ImageObserver, java.awt.MenuContainer, java.io.Serializable, javax.accessibility.Accessible, javax.swing.RootPaneContainer, javax.swing.WindowConstants, PluginHolder

public class PluginDialog
extends javax.swing.JDialog
implements PluginHolder

Shows a VisiblePlugin in a dialog. Optionally, the id of a return page (a JaspiraPage) can be provided to this class on construction. If the dialog is closed, its contained plugin will be added to the page.

Author:

Jens Ferchland

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class javax.swing.JDialog

javax.swing.JDialog.AccessibleJDialog

Nested classes/interfaces inherited from class java.awt.Dialog

java.awt.Dialog.AccessibleAWTDialog, java.awt.Dialog.ModalExclusionType, java.awt.Dialog.ModalityType

Nested classes/interfaces inherited from class java.awt.Window

java.awt.Window.AccessibleAWTWindow

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

Field Summary

protected java.lang.ref.WeakReference

focusedPlugin Used to store the plugin that had the focus before calling the dialog as modal dialog.

Fields inherited from class javax.swing.JDialog

accessibleContext, rootPane, rootPaneCheckingEnabled

Fields inherited from class java.awt.Dialog

DEFAULT_MODALITY_TYPE

Fields inherited from class java.awt.Component

BOTTOM_ALIGNMENT, CENTER_ALIGNMENT, LEFT_ALIGNMENT, RIGHT_ALIGNMENT, TOP_ALIGNMENT

Fields inherited from interface javax.swing.WindowConstants

DISPOSE_ON_CLOSE, DO_NOTHING_ON_CLOSE, EXIT_ON_CLOSE, HIDE_ON_CLOSE

Fields inherited from interface java.awt.image.ImageObserver

ABORT, ALLBITS, ERROR, FRAMEBITS, HEIGHT, PROPERTIES, SOMEBITS, WIDTH

Constructor Summary

PluginDialog(java.awt.Dialog owner, VisiblePlugin plugin, java.lang.String returnPageId)
Constructor, creating a modeless dialog using the graphics configuration of the owner.

PluginDialog(java.awt.Dialog owner, VisiblePlugin plugin, java.lang.String returnPageId, boolean modal)
Constructor, using the graphics configuration of the owner.

PluginDialog(java.awt.Dialog owner, VisiblePlugin plugin, java.lang.String returnPageId, boolean modal, java.awt.GraphicsConfiguration gc)
Constructor, using a dialog as owner.

PluginDialog(java.awt.Frame owner, VisiblePlugin plugin, java.lang.String returnPageId)
Constructor, creating a modeless dialog using the graphics configuration of the owner.

PluginDialog(java.awt.Frame owner, VisiblePlugin plugin, java.lang.String returnPageId, boolean modal)
Constructor, using the graphics configuration of the owner.

PluginDialog(java.awt.Frame owner, VisiblePlugin plugin, java.lang.String returnPageId, boolean modal, java.awt.GraphicsConfiguration gc)
Constructor, using a frame as owner.

PluginDialog(VisiblePlugin plugin)
Constructor, creating a modeless dialog without owner using the default graphics configuration.

PluginDialog(VisiblePlugin plugin, java.lang.String returnPageId)
Constructor, creating a modeless dialog without owner using the default graphics configuration.

Method Summary

protected void	buildToolBar() Builds the frame's tool bar.
void	close() Closes the dialog and handles the plugin.
protected void	init(VisiblePlugin plugin, java.lang.String returnPageId) Initializes the dialog.
void	setVisible(boolean visible)
void	showHolder(boolean changePage) Brings the plugin dialog to the front.
void	unlinkHolder() Unlinks the holder from its container.
void	updateHolder(boolean fullRebuild) Rebuilds the title, tool and menu bars of the holder.

Methods inherited from class javax.swing.JDialog

addImpl, createRootPane, dialogInit, getAccessibleContext, getContentPane, getDefaultCloseOperation, getGlassPane, getGraphics, getJMenuBar, getLayeredPane, getRootPane, getTransferHandler, isDefaultLookAndFeelDecorated, isRootPaneCheckingEnabled, paramString, processWindowEvent, remove, repaint, setContentPane, setDefaultCloseOperation, setDefaultLookAndFeelDecorated, setGlassPane, setJMenuBar, setLayeredPane, setLayout, setRootPane, setRootPaneCheckingEnabled, setTransferHandler, update

Methods inherited from class java.awt.Dialog

addNotify, getModalityType, getTitle, hide, isModal, isResizable, isUndecorated, setModal, setModalityType, setResizable, setTitle, setUndecorated, show, toBack

Methods inherited from class java.awt.Window

addPropertyChangeListener, addPropertyChangeListener, addWindowFocusListener, addWindowListener, addWindowStateListener, applyResourceBundle, applyResourceBundle, createBufferStrategy, createBufferStrategy, dispose, getBufferStrategy, getFocusableWindowState, getFocusCycleRootAncestor, getFocusOwner, getFocusTraversalKeys, getGraphicsConfiguration, getIconImages, getInputContext, getListeners, getLocale, getModalExclusionType, getMostRecentFocusOwner, getOwnedWindows, getOwner, getOwnerlessWindows, getToolkit, getWarningString, getWindowFocusListeners, getWindowListeners, getWindows, getWindowStateListeners, isActive, isAlwaysOnTop, isAlwaysOnTopSupported, isFocusableWindow, isFocusCycleRoot, isFocused, isLocationByPlatform, isShowing, pack, paint, postEvent, processEvent, processWindowFocusEvent, processWindowStateEvent, removeNotify, removeWindowFocusListener, removeWindowListener, removeWindowStateListener, reshape, setAlwaysOnTop, setBounds, setBounds, setCursor, setFocusableWindowState, setFocusCycleRoot, setIconImage, setIconImages, setLocationByPlatform, setLocationRelativeTo, setMinimumSize, setModalExclusionType, setSize, setSize, toFront

Methods inherited from class java.awt.Container

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, processContainerEvent, remove, removeAll, removeContainerListener, setComponentZOrder, setFocusTraversalKeys, setFocusTraversalPolicy, setFocusTraversalPolicyProvider, setFont, 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, contains, createImage, createImage, createVolatileImage, createVolatileImage, disable, disableEvents, dispatchEvent, enable, enable, enableEvents, enableInputMethods, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, getBackground, getBaseline, getBaselineResizeBehavior, getBounds, getBounds, getColorModel, getComponentListeners, getComponentOrientation, getCursor, getDropTarget, getFocusListeners, getFocusTraversalKeysEnabled, getFont, getFontMetrics, getForeground, 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, isOpaque, isPreferredSizeSet, isValid, isVisible, keyDown, keyUp, list, list, list, location, lostFocus, mouseDown, mouseDrag, mouseEnter, mouseExit, mouseMove, mouseUp, move, nextFocus, paintAll, prepareImage, prepareImage, printAll, processComponentEvent, processFocusEvent, processHierarchyBoundsEvent, processHierarchyEvent, processInputMethodEvent, processKeyEvent, processMouseEvent, processMouseMotionEvent, processMouseWheelEvent, remove, removeComponentListener, removeFocusListener, removeHierarchyBoundsListener, removeHierarchyListener, removeInputMethodListener, removeKeyListener, removeMouseListener, removeMouseMotionListener, removeMouseWheelListener, removePropertyChangeListener, removePropertyChangeListener, repaint, repaint, repaint, requestFocus, requestFocus, requestFocusInWindow, requestFocusInWindow, resize, resize, setBackground, setComponentOrientation, setDropTarget, setEnabled, setFocusable, setFocusTraversalKeysEnabled, setForeground, setIgnoreRepaint, setLocale, setLocation, setLocation, setMaximumSize, setName, setPreferredSize, show, size, toString, transferFocus, transferFocusUpCycle

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

focusedPlugin

protected java.lang.ref.WeakReference focusedPlugin

Used to store the plugin that had the focus before calling the dialog as modal dialog. This is a temporary variable only, so we use weak references here in order to prevent memory leaks.

Constructor Detail

PluginDialog

public PluginDialog(java.awt.Frame owner,
                    VisiblePlugin plugin,
                    java.lang.String returnPageId,
                    boolean modal,
                    java.awt.GraphicsConfiguration gc)

Constructor, using a frame as owner.

Parameters:

owner - Dialog owner

plugin - Contained plugin

returnPageId - Id of the JaspiraPage to add the plugin to after window closing. If this id is null, the plugin will be uninstalled if the dialog is closed.

modal - true Display as modal dialog
false Display as modeless dialog

gc - Graphics configuration for dialog display

PluginDialog

public PluginDialog(java.awt.Frame owner,
                    VisiblePlugin plugin,
                    java.lang.String returnPageId,
                    boolean modal)

Constructor, using the graphics configuration of the owner.

Parameters:

owner - Dialog owner

plugin - Contained plugin

returnPageId - Id of the JaspiraPage to add the plugin to after window closing. If this id is null, the plugin will be uninstalled if the dialog is closed.

modal - true Display as modal dialog
false Display as modeless dialog

PluginDialog

public PluginDialog(java.awt.Frame owner,
                    VisiblePlugin plugin,
                    java.lang.String returnPageId)

Constructor, creating a modeless dialog using the graphics configuration of the owner.

Parameters:

owner - Dialog owner

plugin - Contained plugin

returnPageId - Id of the JaspiraPage to add the plugin to after window closing. If this id is null, the plugin will be uninstalled if the dialog is closed.

PluginDialog

public PluginDialog(java.awt.Dialog owner,
                    VisiblePlugin plugin,
                    java.lang.String returnPageId,
                    boolean modal,
                    java.awt.GraphicsConfiguration gc)

Constructor, using a dialog as owner.

Parameters:

owner - Dialog owner

plugin - Contained plugin

returnPageId - Id of the JaspiraPage to add the plugin to after window closing. If this id is null, the plugin will be uninstalled if the dialog is closed.

modal - true Display as modal dialog
false Display as modeless dialog

gc - Graphics configuration for dialog display

PluginDialog

public PluginDialog(java.awt.Dialog owner,
                    VisiblePlugin plugin,
                    java.lang.String returnPageId,
                    boolean modal)

Constructor, using the graphics configuration of the owner.

Parameters:

owner - Dialog owner

plugin - Contained plugin

returnPageId - Id of the JaspiraPage to add the plugin to after window closing. If this id is null, the plugin will be uninstalled if the dialog is closed.

modal - true Display as modal dialog
false Display as modeless dialog

PluginDialog

public PluginDialog(java.awt.Dialog owner,
                    VisiblePlugin plugin,
                    java.lang.String returnPageId)

Constructor, creating a modeless dialog using the graphics configuration of the owner.

Parameters:

owner - Dialog owner

plugin - Contained plugin

returnPageId - Id of the JaspiraPage to add the plugin to after window closing. If this id is null, the plugin will be uninstalled if the dialog is closed.

PluginDialog

public PluginDialog(VisiblePlugin plugin,
                    java.lang.String returnPageId)

Constructor, creating a modeless dialog without owner using the default graphics configuration.

Parameters:

plugin - Contained plugin

returnPageId - Id of the JaspiraPage to add the plugin to after window closing. If this id is null, the plugin will be uninstalled if the dialog is closed.

PluginDialog

public PluginDialog(VisiblePlugin plugin)

Constructor, creating a modeless dialog without owner using the default graphics configuration.

Parameters:

plugin - Contained plugin

Method Detail

init

protected void init(VisiblePlugin plugin,
                    java.lang.String returnPageId)

Initializes the dialog.

Parameters:

plugin - Contained plugin

returnPageId - Id of the JaspiraPage to add the plugin to after window closing. If this id is null, the plugin will be uninstalled if the dialog is closed.

buildToolBar

protected void buildToolBar()

Builds the frame's tool bar.

close

public void close()

Closes the dialog and handles the plugin. If the return page id is null or the page doesn't exist, the plugin will be uninstalled.

setVisible

public void setVisible(boolean visible)

Overrides:

setVisible in class java.awt.Dialog

showHolder

public void showHolder(boolean changePage)

Brings the plugin dialog to the front.

Specified by:

showHolder in interface PluginHolder

Parameters:

changePage - Ignored

updateHolder

public void updateHolder(boolean fullRebuild)

Description copied from interface: PluginHolder

Rebuilds the title, tool and menu bars of the holder.

Specified by:

updateHolder in interface PluginHolder

Parameters:

fullRebuild - true Causes a full environment rebuild including menu and toolbar rebuild
false Updates the holder's title only and checks for toolbar size change

unlinkHolder

public void unlinkHolder()

Description copied from interface: PluginHolder

Unlinks the holder from its container. If the holder is a top-level plugin holder (such as a dialog or a frame), this will remove the holder itself.

Specified by:

unlinkHolder in interface PluginHolder