SalesPoint v3.3 API

sale
Class JDisplayFrame

java.lang.Object
  extended by java.awt.Component
      extended by java.awt.Container
          extended by java.awt.Window
              extended by java.awt.Frame
                  extended by javax.swing.JFrame
                      extended by sale.JDisplayFrame
All Implemented Interfaces:
ImageObserver, MenuContainer, Serializable, Accessible, RootPaneContainer, WindowConstants, Display
Direct Known Subclasses:
MultiWindow.DisplayFrame

public class JDisplayFrame
extends JFrame
implements Display

A JFrame that can display Form- and MenuSheets.

You can use this frame to pop up messages and dialogs in extra windows, while maintaining consistency with the rest of the GUI by using the familiar FormSheet look'n'feel.

The frame will display one FormSheet. Closing the frame using the systems menu or any other OS dependent gesture will result in a call to FormSheet.cancel() on the FormSheet.

Also, the frame may display a MenuSheet. It can therefore be used wherever a Display can be used.

Attention: This class is not meant to be serialized. See load() and store() for details.

Since:
v3.0
Author:
Steffen Zschaler, Thomas Medack
See Also:
Serialized Form

Nested Class Summary
 
Nested classes/interfaces inherited from class javax.swing.JFrame
JFrame.AccessibleJFrame
 
Nested classes/interfaces inherited from class java.awt.Frame
Frame.AccessibleAWTFrame
 
Nested classes/interfaces inherited from class java.awt.Window
Window.AccessibleAWTWindow
 
Nested classes/interfaces inherited from class java.awt.Container
Container.AccessibleAWTContainer
 
Nested classes/interfaces inherited from class java.awt.Component
Component.AccessibleAWTComponent, Component.BltBufferStrategy, Component.FlipBufferStrategy
 
Field Summary
protected  ListenerHelper m_lhListeners
          The list of listeners.
 
Fields inherited from class javax.swing.JFrame
accessibleContext, EXIT_ON_CLOSE, rootPane, rootPaneCheckingEnabled
 
Fields inherited from class java.awt.Frame
CROSSHAIR_CURSOR, DEFAULT_CURSOR, E_RESIZE_CURSOR, HAND_CURSOR, ICONIFIED, MAXIMIZED_BOTH, MAXIMIZED_HORIZ, MAXIMIZED_VERT, MOVE_CURSOR, N_RESIZE_CURSOR, NE_RESIZE_CURSOR, NORMAL, NW_RESIZE_CURSOR, S_RESIZE_CURSOR, SE_RESIZE_CURSOR, SW_RESIZE_CURSOR, TEXT_CURSOR, W_RESIZE_CURSOR, WAIT_CURSOR
 
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, HIDE_ON_CLOSE
 
Fields inherited from interface java.awt.image.ImageObserver
ABORT, ALLBITS, ERROR, FRAMEBITS, HEIGHT, PROPERTIES, SOMEBITS, WIDTH
 
Constructor Summary
JDisplayFrame()
          Create a new JDisplayFrame.
 
Method Summary
 void addFormSheetListener(FormSheetListener fsl)
          Add a listener to receive notification on the JDisplayFrame's FormSheet.
 void closeFormSheet()
          Close the current FormSheet.
 void closeFormSheet(FormSheet fs)
          Closes a FormSheet.
 void dispose()
          In addition to disposing of the peer resources, remove the FormSheet and the MenuSheet.
protected  void exitForm()
          Hook method called when the frame is about to be closed.
protected  void fireFormSheetRemoved(FormSheet fs, boolean fExplicit)
          Fire an event to all FormSheetListeners indicating that a FormSheet was removed from this display.
protected  void fireFormSheetSet(FormSheet fs)
          Fire an event to all FormSheetListeners indicating that a FormSheet was set on this display.
protected  void formSheetClosed()
          Hook method called when the FormSheet was closed.
 FormSheet getFormSheet()
          Return the FormSheet that is currently attached to the display.
 MenuSheet getMenuSheet()
          Return the MenuSheet that is currently attached to the display.
 String getPrimaryTitle()
           
 String getSecondaryTitle()
           
 boolean isUseableDisplay()
          Return true to indicate this is a useable display.
 void load(ObjectInputStream ois)
          Restore this display frame from data in the given input stream.
protected  void onDisplayFocusGained()
           
 void onFormSheetButtonAdded(FormSheet fs, FormSheet.FormButton fb)
          Notification event informing that a button was added to the FormSheet's button bar.
 void onFormSheetButtonRemoved(FormSheet fs, FormSheet.FormButton fb)
          Notification event informing that a button was removed from the FormSheet's button bar.
 void onFormSheetButtonsCleared(FormSheet fs)
          Notification event informing that all buttons were removed from a FormSheet's button bar.
 void onFormSheetCaptionChanged(FormSheet fs, String sNewCaption)
          Notification event informing about a change of a FormSheet's caption.
 void onFormSheetComponentChanged(FormSheet fs, JComponent jcmpNew)
          Notification event informing about a change of a FormSheet's component.
 void popUpFormSheet(FormSheet fs)
          Open a fresh JDisplayDialog and display the FormSheet in it.
 void removeFormSheetListener(FormSheetListener fsl)
          Remove a listener to receive notification on the JDisplayFrame's FormSheet.
 void save(ObjectOutputStream oos)
          Save this display frame to the given output stream.
 void setBounds(Rectangle r)
          Sets size an position of the display.
 void setDisplayTitle()
           
 void setFormSheet(FormSheet fs)
          Set and display a FormSheet.
 void setMenuSheet(MenuSheet ms)
          Set and display a MenuSheet.
 void setPrimaryTitle(String sPrimaryTitle)
           
 void setSecondaryTitle(String sSecondaryTitle)
           
 
Methods inherited from class javax.swing.JFrame
addImpl, createRootPane, frameInit, getAccessibleContext, getContentPane, getDefaultCloseOperation, getGlassPane, getJMenuBar, getLayeredPane, getRootPane, isDefaultLookAndFeelDecorated, isRootPaneCheckingEnabled, paramString, processWindowEvent, remove, setContentPane, setDefaultCloseOperation, setDefaultLookAndFeelDecorated, setGlassPane, setIconImage, setJMenuBar, setLayeredPane, setLayout, setRootPane, setRootPaneCheckingEnabled, update
 
Methods inherited from class java.awt.Frame
addNotify, finalize, getCursorType, getExtendedState, getFrames, getIconImage, getMaximizedBounds, getMenuBar, getState, getTitle, isResizable, isUndecorated, remove, removeNotify, setCursor, setExtendedState, setMaximizedBounds, setMenuBar, setResizable, setState, setTitle, setUndecorated
 
Methods inherited from class java.awt.Window
addPropertyChangeListener, addPropertyChangeListener, addWindowFocusListener, addWindowListener, addWindowStateListener, applyResourceBundle, applyResourceBundle, createBufferStrategy, createBufferStrategy, getBufferStrategy, getFocusableWindowState, getFocusCycleRootAncestor, getFocusOwner, getFocusTraversalKeys, getGraphicsConfiguration, getInputContext, getListeners, getLocale, getMostRecentFocusOwner, getOwnedWindows, getOwner, getToolkit, getWarningString, getWindowFocusListeners, getWindowListeners, getWindowStateListeners, hide, isActive, isAlwaysOnTop, isFocusableWindow, isFocusCycleRoot, isFocused, isLocationByPlatform, isShowing, pack, postEvent, processEvent, processWindowFocusEvent, processWindowStateEvent, removeWindowFocusListener, removeWindowListener, removeWindowStateListener, setAlwaysOnTop, setBounds, setCursor, setFocusableWindowState, setFocusCycleRoot, setLocationByPlatform, setLocationRelativeTo, show, toBack, 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, paint, 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, getBounds, getBounds, getColorModel, getComponentListeners, getComponentOrientation, getCursor, getDropTarget, getFocusListeners, getFocusTraversalKeysEnabled, getFont, getFontMetrics, getForeground, getGraphics, 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, removeComponentListener, removeFocusListener, removeHierarchyBoundsListener, removeHierarchyListener, removeInputMethodListener, removeKeyListener, removeMouseListener, removeMouseMotionListener, removeMouseWheelListener, removePropertyChangeListener, removePropertyChangeListener, repaint, repaint, repaint, repaint, requestFocus, requestFocus, requestFocusInWindow, requestFocusInWindow, reshape, resize, resize, setBackground, setComponentOrientation, setDropTarget, setEnabled, setFocusable, setFocusTraversalKeysEnabled, setForeground, setIgnoreRepaint, setLocale, setLocation, setLocation, setMaximumSize, setMinimumSize, setName, setPreferredSize, setSize, setSize, setVisible, show, size, toString, transferFocus, transferFocusUpCycle
 
Methods inherited from class java.lang.Object
clone, equals, getClass, hashCode, notify, notifyAll, wait, wait, wait
 
Methods inherited from interface sale.Display
getBounds, toFront
 
Methods inherited from interface java.awt.MenuContainer
getFont, postEvent
 

Field Detail

m_lhListeners

protected ListenerHelper m_lhListeners
The list of listeners.

Constructor Detail

JDisplayFrame

public JDisplayFrame()
Create a new JDisplayFrame.

Method Detail

onDisplayFocusGained

protected void onDisplayFocusGained()

save

public void save(ObjectOutputStream oos)
          throws IOException
Save this display frame to the given output stream. The frame will only store information from which contents and layout can be restored later. The actual frame or any other Swing components will not be stored into the stream.

Specified by:
save in interface Display
Parameters:
oos - the stream to write attributes to
Throws:
IOException

load

public void load(ObjectInputStream ois)
          throws IOException,
                 ClassNotFoundException
Restore this display frame from data in the given input stream.

Specified by:
load in interface Display
Parameters:
ois - the stream to read attributes from
Throws:
IOException
ClassNotFoundException

setPrimaryTitle

public void setPrimaryTitle(String sPrimaryTitle)

getPrimaryTitle

public String getPrimaryTitle()

setSecondaryTitle

public void setSecondaryTitle(String sSecondaryTitle)

getSecondaryTitle

public String getSecondaryTitle()

setDisplayTitle

public void setDisplayTitle()

exitForm

protected void exitForm()
Hook method called when the frame is about to be closed.

By default cancels any FormSheet being currently displayed and closes the frame.


setFormSheet

public void setFormSheet(FormSheet fs)
                  throws InterruptedException
Set and display a FormSheet.

This method should attach a FormSheetContainer as the FormSheet's display, get the FormSheet's caption, component and button bar and render them. The entire peer creation should be synchronized using FormSheet.getComponentLock() and FormSheet.getButtonsLock(), so as not to loose any events.

If fs.waitResponse() returns true, setFormSheet() should block, until the FormSheet is closed by a matching call to a closeFormSheet() method.

If a FormSheet is already being displayed, setFormSheet() should cancel this FormSheet prior to setting the new FormSheet.

Specified by:
setFormSheet in interface Display
Parameters:
fs - the FormSheet to be displayed.
Throws:
InterruptedException - if an interrupt occured while waiting for the FormSheet to be closed.
Override:
Always

setBounds

public void setBounds(Rectangle r)
Description copied from interface: Display
Sets size an position of the display.

Specified by:
setBounds in interface Display
Overrides:
setBounds in class Component
Parameters:
r - the Rectangle that contains the size and position information.

getFormSheet

public FormSheet getFormSheet()
Return the FormSheet that is currently attached to the display.

Specified by:
getFormSheet in interface Display

closeFormSheet

public void closeFormSheet()
Close the current FormSheet. It is up to the display whether the FormSheet will be cancelled or just closed normally.

Specified by:
closeFormSheet in interface Display
Override:
Always

popUpFormSheet

public void popUpFormSheet(FormSheet fs)
                    throws InterruptedException
Open a fresh JDisplayDialog and display the FormSheet in it.

Specified by:
popUpFormSheet in interface Display
Parameters:
fs - the FormSheet to be displayed.
Throws:
InterruptedException - if an interrupt occured while waiting for the FormSheet to be closed.
Override:
Never

setMenuSheet

public void setMenuSheet(MenuSheet ms)
Set and display a MenuSheet.

If a MenuSheet is already being displayed, setMenuSheet() should remove this MenuSheet prior to setting the new MenuSheet.

Specified by:
setMenuSheet in interface Display
Parameters:
ms - the MenuSheet to be displayed. null is a valid value and should result in the current MenuSheet being closed.
Override:
Always

getMenuSheet

public MenuSheet getMenuSheet()
Return the MenuSheet that is currently attached to the display.

Specified by:
getMenuSheet in interface Display

isUseableDisplay

public boolean isUseableDisplay()
Return true to indicate this is a useable display.

Specified by:
isUseableDisplay in interface Display
Override:
Never

addFormSheetListener

public void addFormSheetListener(FormSheetListener fsl)
Add a listener to receive notification on the JDisplayFrame's FormSheet.

Specified by:
addFormSheetListener in interface Display
Parameters:
fsl - the FormSheetListener to be registered.
Override:
Never

removeFormSheetListener

public void removeFormSheetListener(FormSheetListener fsl)
Remove a listener to receive notification on the JDisplayFrame's FormSheet.

Specified by:
removeFormSheetListener in interface Display
Parameters:
fsl - the FormSheetListener to be unregistered.
Override:
Never

fireFormSheetSet

protected void fireFormSheetSet(FormSheet fs)
Fire an event to all FormSheetListeners indicating that a FormSheet was set on this display. As FormSheet setting is always explicit, no extra parameter is necessary.

Parameters:
fs - the FormSheet that was set
Override:
Never

fireFormSheetRemoved

protected void fireFormSheetRemoved(FormSheet fs,
                                    boolean fExplicit)
Fire an event to all FormSheetListeners indicating that a FormSheet was removed from this display.

Parameters:
fs - the FormSheet that was set
fExplicit - true, if the FormSheet was closed explicitly, i.e. either by a call to one of the closeFormSheet methods or by setFormSheet (null).
See Also:
closeFormSheet(), closeFormSheet(FormSheet), setFormSheet(sale.FormSheet)
Override:
Never

closeFormSheet

public void closeFormSheet(FormSheet fs)
Closes a FormSheet.

If a FormSheet is closed, by default, the JDisplayDialog containing it is also closed. You can, however, alter this behavior by overriding formSheetClosed().

Parameters:
fs - the FormSheet to be closed.
Override:
Never Instead override formSheetClosed().

formSheetClosed

protected void formSheetClosed()
Hook method called when the FormSheet was closed.

Override:
Sometimes The default implementation calls exitForm().

dispose

public void dispose()
In addition to disposing of the peer resources, remove the FormSheet and the MenuSheet.

Overrides:
dispose in class Window
Override:
Never

onFormSheetCaptionChanged

public void onFormSheetCaptionChanged(FormSheet fs,
                                      String sNewCaption)
Notification event informing about a change of a FormSheet's caption.

Parameters:
fs - the FormSheet whose caption changed.
sNewCaption - the new caption of the FormSheet.
Override:
Always

onFormSheetComponentChanged

public void onFormSheetComponentChanged(FormSheet fs,
                                        JComponent jcmpNew)
Notification event informing about a change of a FormSheet's component.

Parameters:
fs - the FormSheet whose component changed.
jcmpNew - the new component of the FormSheet.
Override:
Always

onFormSheetButtonAdded

public void onFormSheetButtonAdded(FormSheet fs,
                                   FormSheet.FormButton fb)
Notification event informing that a button was added to the FormSheet's button bar.

Parameters:
fs - the FormSheet whose button bar changed.
fb - the button that was added to the FormSheet.
Override:
Always

onFormSheetButtonRemoved

public void onFormSheetButtonRemoved(FormSheet fs,
                                     FormSheet.FormButton fb)
Notification event informing that a button was removed from the FormSheet's button bar.

Parameters:
fs - the FormSheet whose button bar changed.
fb - the button that was removed from the FormSheet.
Override:
Always

onFormSheetButtonsCleared

public void onFormSheetButtonsCleared(FormSheet fs)
Notification event informing that all buttons were removed from a FormSheet's button bar.

Parameters:
fs - the FormSheet whose button bar was cleared.
Override:
Always

SalesPoint v3.3 API