|
SalesPoint v3.3 API | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object java.awt.Component java.awt.Container java.awt.Window java.awt.Frame javax.swing.JFrame sale.JDisplayFrame
public class JDisplayFrame
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.
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 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.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 |
---|
protected ListenerHelper m_lhListeners
Constructor Detail |
---|
public JDisplayFrame()
Method Detail |
---|
protected void onDisplayFocusGained()
public void save(ObjectOutputStream oos) throws IOException
save
in interface Display
oos
- the stream to write attributes to
IOException
public void load(ObjectInputStream ois) throws IOException, ClassNotFoundException
load
in interface Display
ois
- the stream to read attributes from
IOException
ClassNotFoundException
public void setPrimaryTitle(String sPrimaryTitle)
public String getPrimaryTitle()
public void setSecondaryTitle(String sSecondaryTitle)
public String getSecondaryTitle()
public void setDisplayTitle()
protected void exitForm()
By default cancels any FormSheet being currently displayed and closes the frame.
public void setFormSheet(FormSheet fs) throws InterruptedException
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.
setFormSheet
in interface Display
fs
- the FormSheet to be displayed.
InterruptedException
- if an interrupt occured while waiting for the
FormSheet to be closed.public void setBounds(Rectangle r)
Display
setBounds
in interface Display
setBounds
in class Component
r
- the Rectangle that contains the size and position information.public FormSheet getFormSheet()
FormSheet
that is currently attached to the display.
getFormSheet
in interface Display
public void closeFormSheet()
closeFormSheet
in interface Display
public void popUpFormSheet(FormSheet fs) throws InterruptedException
JDisplayDialog
and display the FormSheet in it.
popUpFormSheet
in interface Display
fs
- the FormSheet to be displayed.
InterruptedException
- if an interrupt occured while waiting for the
FormSheet to be closed.public void setMenuSheet(MenuSheet ms)
If a MenuSheet is already being displayed, setMenuSheet()
should remove this
MenuSheet prior to setting the new MenuSheet.
setMenuSheet
in interface Display
ms
- the MenuSheet to be displayed. null
is a valid value and should result in the
current MenuSheet being closed.public MenuSheet getMenuSheet()
MenuSheet
that is currently attached to the display.
getMenuSheet
in interface Display
public boolean isUseableDisplay()
isUseableDisplay
in interface Display
public void addFormSheetListener(FormSheetListener fsl)
addFormSheetListener
in interface Display
fsl
- the FormSheetListener to be registered.public void removeFormSheetListener(FormSheetListener fsl)
removeFormSheetListener
in interface Display
fsl
- the FormSheetListener to be unregistered.protected void fireFormSheetSet(FormSheet fs)
FormSheetListeners
indicating that
a FormSheet
was set on this display. As FormSheet setting is always explicit, no
extra parameter is necessary.
fs
- the FormSheet that was setprotected void fireFormSheetRemoved(FormSheet fs, boolean fExplicit)
FormSheetListeners
indicating that
a FormSheet
was removed from this display.
fs
- the FormSheet that was setfExplicit
- true, if the FormSheet was closed explicitly, i.e. either by a call to one of
the closeFormSheet
methods or by setFormSheet (null)
.closeFormSheet()
,
closeFormSheet(FormSheet)
,
setFormSheet(sale.FormSheet)
public void closeFormSheet(FormSheet fs)
If a FormSheet is closed, by default, the JDisplayDialog containing it is also closed. You can,
however, alter this behavior by overriding formSheetClosed()
.
fs
- the FormSheet to be closed.formSheetClosed()
.protected void formSheetClosed()
exitForm()
.public void dispose()
dispose
in class Window
public void onFormSheetCaptionChanged(FormSheet fs, String sNewCaption)
fs
- the FormSheet whose caption changed.sNewCaption
- the new caption of the FormSheet.public void onFormSheetComponentChanged(FormSheet fs, JComponent jcmpNew)
fs
- the FormSheet whose component changed.jcmpNew
- the new component of the FormSheet.public void onFormSheetButtonAdded(FormSheet fs, FormSheet.FormButton fb)
fs
- the FormSheet whose button bar changed.fb
- the button that was added to the FormSheet.public void onFormSheetButtonRemoved(FormSheet fs, FormSheet.FormButton fb)
fs
- the FormSheet whose button bar changed.fb
- the button that was removed from the FormSheet.public void onFormSheetButtonsCleared(FormSheet fs)
fs
- the FormSheet whose button bar was cleared.
|
SalesPoint v3.3 API | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |