|
|||||||||
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 com.levigo.util.swing.AbstractGeometryFrame
public abstract class AbstractGeometryFrame
Use AbstractGeometryFrame
class as superclass for frames which
provides services to read and save their location and size from a predefined
preference store. Developers should override the restore geometry method as
well as the save geometry method, because some preference stores might store
blobs, eg. a Point or a Dimension, others not. As well, developers might use
this class to define a unique window icon and to install common UI settings.
Caveat: The support of the automatic saving and of frames geometry DO
NOT WORK PROPERLY if the frames default closing operation is set to
JFrame.EXIT_ON_CLOSE
. Use another default closing
operation and make use of a WindowListener to shut down your application.
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.BaselineResizeBehavior, Component.BltBufferStrategy, Component.FlipBufferStrategy |
Field Summary | |
---|---|
static Image |
WINDOW_ICON
The image that is used as a frame's icon image. |
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 | |
---|---|
AbstractGeometryFrame(String title)
Constructor for AbstractGeometryFrame. |
Method Summary | |
---|---|
protected static AbstractGeometryFrame |
getActiveFrame(String frameType,
String frameID)
Retrieve the first (i.e. |
static Collection<JFrame> |
getActiveFrames()
Retrieves a collection of all currently active frames. |
protected static Collection<JFrame> |
getActiveFrames(String frameType)
Retrieve all currently active frames of a given type. |
static Collection<JFrame> |
getActiveFramesinZOrder()
Retrieves a collection of all currently active frames in the current z-order. |
protected static Image |
getAuxiliaryWindowIcon(String iconIdentifier)
Returns the auxiliary window icon defined via the given icon identifier. |
protected Point |
getDefaultLocation()
The default location for new frames. |
protected Dimension |
getDefaultSize()
The default size for new frames. |
String |
getFrameID()
Get the frame's ID. |
abstract String |
getFrameType()
Returns the type or identification of this frame instance. |
static com.levigo.util.preferences.PreferenceStore |
getPreferenceStore()
Gets the PreferenceStore where user preferences can be stored. |
static Frame |
getRecentlyFocusedFrame()
Returns the most recently activated and focused AbstractGeometryFrame instance. |
protected static Image |
getWindowIcon()
Gets the window icon used as default icon for all frames of this type. |
void |
hide()
Deprecated. |
protected boolean |
isExistingFrameAt(Point p)
Check whether there is already an active frame with the same type like this frame at the given location. |
protected void |
processWindowEvent(WindowEvent e)
|
static void |
putAuxiliaryWindowIcon(String iconIdentifier,
Image image)
Associates the specified auxiliary window icon with the specified identifier. |
abstract void |
restoreGeometry()
Restore the frame geometry (size, location) from the preferences. |
abstract void |
saveGeometry()
Save the frame geometry into the properties. |
static void |
setPreferenceStore(com.levigo.util.preferences.PreferenceStore preferenceStore)
Sets the preferenceStore. |
static void |
setRecentlyFocusedFrame(AbstractGeometryFrame recentlyFocusedFrame)
Sets the most recently activated and focused AbstractGeometryFrame instance. |
static void |
setWindowIcon(Image image)
Sets a window icon for all frames using this class as superclass. |
void |
show()
Deprecated. |
Methods inherited from class java.awt.Frame |
---|
addNotify, 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, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Methods inherited from interface java.awt.MenuContainer |
---|
getFont, postEvent |
Field Detail |
---|
public static Image WINDOW_ICON
Constructor Detail |
---|
public AbstractGeometryFrame(String title)
title
- The title of the frameMethod Detail |
---|
protected Point getDefaultLocation()
protected Dimension getDefaultSize()
public abstract void restoreGeometry()
protected boolean isExistingFrameAt(Point p)
p
- The location to check for an existing frame
public abstract void saveGeometry()
@Deprecated public void show()
show
in class Window
Window.show()
@Deprecated public void hide()
hide
in class Window
Window.hide()
public static Frame getRecentlyFocusedFrame()
public static Collection<JFrame> getActiveFrames()
public static Collection<JFrame> getActiveFramesinZOrder()
The resulting collection will be ordered in ascending z-order, i.e. the top-most frame appears first. This order, however, will only reflect frames which are derived from AbstractGeometryFrame. Therefore the top-most frame is not guaranteed to be the focus owner.
protected static Collection<JFrame> getActiveFrames(String frameType)
frameType
- The type of a frame.
protected static AbstractGeometryFrame getActiveFrame(String frameType, String frameID)
frameType
- The type of a frameframeID
- The ID of the frame to find
public static com.levigo.util.preferences.PreferenceStore getPreferenceStore()
public static void setPreferenceStore(com.levigo.util.preferences.PreferenceStore preferenceStore)
preferenceStore
- The preferenceStore to setpublic static void setWindowIcon(Image image)
image
- new Window icon for all frames of this typepublic static void putAuxiliaryWindowIcon(String iconIdentifier, Image image)
iconIdentifier
- key with which the specified value is to be
associated.image
- value to be associated with the specified key.protected static Image getAuxiliaryWindowIcon(String iconIdentifier)
iconIdentifier
-
protected static Image getWindowIcon()
public String getFrameID()
public abstract String getFrameType()
public static void setRecentlyFocusedFrame(AbstractGeometryFrame recentlyFocusedFrame)
recentlyFocusedFrame
- protected void processWindowEvent(WindowEvent e)
processWindowEvent
in class JFrame
Window.processWindowEvent(java.awt.event.WindowEvent)
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |