Module org.autogui

Package org.autogui.swing

Class GuiSwingWindow

java.lang.Object

java.awt.Component

java.awt.Container

java.awt.Window

java.awt.Frame

javax.swing.JFrame

org.autogui.swing.GuiSwingWindow

All Implemented Interfaces:

ImageObserver, MenuContainer, Serializable, Accessible, RootPaneContainer, WindowConstants, GuiSwingPreferences.RootView

public class GuiSwingWindow
extends JFrame
implements GuiSwingPreferences.RootView

a root window wrapping a GuiSwingRootPane.

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	GuiSwingWindow.GuiSwingWindowCreator

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, Window.Type

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

Fields

Modifier and Type	Field	Description
protected Image	appIcon
protected GuiSwingRootPane	contextRootPane
protected boolean	exitAfterDispose
protected GuiSwingPreferences.WindowPreferencesUpdater	preferencesUpdater

Fields inherited from class javax.swing.JFrame

accessibleContext, 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 java.awt.image.ImageObserver

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

Fields inherited from interface javax.swing.WindowConstants

DISPOSE_ON_CLOSE, DO_NOTHING_ON_CLOSE, EXIT_ON_CLOSE, HIDE_ON_CLOSE

Constructor Summary

Constructors

Constructor	Description
GuiSwingWindow(GuiMappingContext context)
GuiSwingWindow(GuiMappingContext context, GuiSwingView view, GuiSwingKeyBinding keyBinding, boolean logStatus, SettingsWindow settingsWindow)
GuiSwingWindow(GuiSwingRootPane contextRootPane)

Method Summary

Modifier and Type	Method	Description
void	cleanUp()
void	close()
static GuiSwingWindow	createForObject(Object o)
static GuiSwingWindow	createForObjectRelaxed(Object o)
static GuiSwingWindow.GuiSwingWindowCreator	creator()
void	dispose()
GuiSwingActionDefault.ExecutionAction	getActionByContext(GuiMappingContext context)
GuiSwingActionDefault.ExecutionAction	getActionByName(String name)
GuiSwingView.ValuePane<Object>	getChildByName(String name)
GuiMappingContext	getContext()
GuiSwingRootPane	getContextRootPane()
GuiSwingActionDefault.ExecutionAction	getDescendantActionByContext(GuiMappingContext context)
GuiSwingView.ValuePane<Object>	getDescendantByContext(GuiMappingContext context)
GuiSwingView.ValuePane<Object>	getDescendantByValue(Object value)
GuiSwingView.ValuePane<Object>	getDescendantByValueIf(Predicate<Object> valuePredicate)
GuiSwingPreferences	getPreferences()
JComponent	getViewComponent()
GuiSwingView.ValuePane<Object>	getViewValuePane()
protected void	init()
protected void	initClosing()
protected void	initIcon()
protected void	initMenu()
protected void	initMenuScreen()	setting up the menu property
protected void	initPrefsLoad()
protected void	initPrefsUpdater()
protected void	initTitle()
protected void	initViewComponentSet()
boolean	isApplicationRoot()
boolean	isExitAfterDispose()
void	loadPreferences(GuiPreferences prefs, GuiSwingPreferences.PrefsApplyOptions options)
void	refreshByContext()	the convenient method for refreshing the pane
void	savePreferences(GuiPreferences prefs)
void	setApplicationRoot(boolean applicationRoot)
void	setExitAfterDispose(boolean exitAfterDispose)

Methods inherited from class javax.swing.JFrame

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

Methods inherited from class java.awt.Frame

addNotify, getCursorType, getExtendedState, getFrames, getIconImage, getMaximizedBounds, getMenuBar, getState, getTitle, isResizable, isUndecorated, remove, removeNotify, setBackground, setCursor, setExtendedState, setMaximizedBounds, setMenuBar, setOpacity, setResizable, setShape, setState, setTitle, setUndecorated

Methods inherited from class java.awt.Window

addPropertyChangeListener, addPropertyChangeListener, addWindowFocusListener, addWindowListener, addWindowStateListener, applyResourceBundle, applyResourceBundle, createBufferStrategy, createBufferStrategy, getBackground, getBufferStrategy, getFocusableWindowState, getFocusCycleRootAncestor, getFocusOwner, getFocusTraversalKeys, getIconImages, getInputContext, getListeners, getLocale, getModalExclusionType, getMostRecentFocusOwner, getOpacity, getOwnedWindows, getOwner, getOwnerlessWindows, getShape, getToolkit, getType, getWarningString, getWindowFocusListeners, getWindowListeners, getWindows, getWindowStateListeners, hide, isActive, isAlwaysOnTop, isAlwaysOnTopSupported, isAutoRequestFocus, isFocusableWindow, isFocusCycleRoot, isFocused, isLocationByPlatform, isOpaque, isShowing, isValidateRoot, pack, paint, postEvent, processEvent, processWindowFocusEvent, processWindowStateEvent, removeWindowFocusListener, removeWindowListener, removeWindowStateListener, reshape, setAlwaysOnTop, setAutoRequestFocus, setBounds, setBounds, setCursor, setFocusableWindowState, setFocusCycleRoot, setIconImages, setLocation, setLocation, setLocationByPlatform, setLocationRelativeTo, setMinimumSize, setModalExclusionType, setSize, setSize, setType, setVisible, 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, paintComponents, preferredSize, print, printComponents, processContainerEvent, remove, removeAll, removeContainerListener, setComponentZOrder, setFocusTraversalKeys, setFocusTraversalPolicy, setFocusTraversalPolicyProvider, setFont, 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, getBaseline, getBaselineResizeBehavior, getBounds, getBounds, getColorModel, getComponentListeners, getComponentOrientation, getCursor, getDropTarget, getFocusListeners, getFocusTraversalKeysEnabled, getFont, getFontMetrics, getForeground, getGraphicsConfiguration, getHeight, getHierarchyBoundsListeners, getHierarchyListeners, getIgnoreRepaint, getInputMethodListeners, getInputMethodRequests, getKeyListeners, getLocation, getLocation, getLocationOnScreen, getMouseListeners, getMouseMotionListeners, getMousePosition, getMouseWheelListeners, getName, getParent, 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, 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, requestFocus, requestFocus, requestFocus, requestFocus, requestFocusInWindow, requestFocusInWindow, requestFocusInWindow, resize, resize, revalidate, setComponentOrientation, setDropTarget, setEnabled, setFocusable, setFocusTraversalKeysEnabled, setForeground, setIgnoreRepaint, setLocale, setMaximumSize, setMixingCutoutShape, setName, setPreferredSize, show, size, toString, transferFocus, transferFocusBackward, transferFocusUpCycle

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.autogui.swing.GuiSwingPreferences.RootView

loadPreferences

Methods inherited from interface java.awt.MenuContainer

getFont, postEvent

Field Details

contextRootPane

protected GuiSwingRootPane contextRootPane

preferencesUpdater

protected GuiSwingPreferences.WindowPreferencesUpdater preferencesUpdater

exitAfterDispose

protected boolean exitAfterDispose

Since:

1.1

appIcon

protected Image appIcon

Since:

1.5

Constructor Details

GuiSwingWindow

public GuiSwingWindow(GuiMappingContext context)
               throws HeadlessException

Throws:

HeadlessException

GuiSwingWindow

public GuiSwingWindow(GuiMappingContext context,
 GuiSwingView view,
 GuiSwingKeyBinding keyBinding,
 boolean logStatus,
 SettingsWindow settingsWindow)
               throws HeadlessException

Throws:

HeadlessException

GuiSwingWindow

public GuiSwingWindow(GuiSwingRootPane contextRootPane)

Method Details

createForObject

public static GuiSwingWindow createForObject(Object o)

createForObjectRelaxed

public static GuiSwingWindow createForObjectRelaxed(Object o)

creator

public static GuiSwingWindow.GuiSwingWindowCreator creator()

getContext

public GuiMappingContext getContext()

Specified by:

getContext in interface GuiSwingPreferences.RootView

getContextRootPane

public GuiSwingRootPane getContextRootPane()

getViewComponent

public JComponent getViewComponent()

Specified by:

getViewComponent in interface GuiSwingPreferences.RootView

init

protected void init()

initTitle

protected void initTitle()

initViewComponentSet

protected void initViewComponentSet()

initMenu

protected void initMenu()

initMenuScreen

protected void initMenuScreen()

setting up the menu property

Since:

1.2

initIcon

protected void initIcon()

initPrefsUpdater

protected void initPrefsUpdater()

initPrefsLoad

protected void initPrefsLoad()

initClosing

protected void initClosing()

close

public void close()

isApplicationRoot

public boolean isApplicationRoot()

setApplicationRoot

public void setApplicationRoot(boolean applicationRoot)

setExitAfterDispose

public void setExitAfterDispose(boolean exitAfterDispose)

Parameters:

exitAfterDispose - if true, System.exit(int) with 0 after disposing the window.

Since:

1.1

isExitAfterDispose

public boolean isExitAfterDispose()

Returns:

the current flag

Since:

1.1

cleanUp

public void cleanUp()

dispose

public void dispose()

Overrides:

dispose in class Window

getPreferences

public GuiSwingPreferences getPreferences()

loadPreferences

public void loadPreferences(GuiPreferences prefs,
 GuiSwingPreferences.PrefsApplyOptions options)

Specified by:

loadPreferences in interface GuiSwingPreferences.RootView

Parameters:

prefs - the source prefs

options - options for applying (GuiSwingPreferences.APPLY_OPTIONS_DEFAULT for GuiSwingPreferences.RootView.loadPreferences(GuiPreferences) that are all false)

savePreferences

public void savePreferences(GuiPreferences prefs)

Specified by:

savePreferences in interface GuiSwingPreferences.RootView

getViewValuePane

public GuiSwingView.ValuePane<Object> getViewValuePane()

getDescendantByContext

public GuiSwingView.ValuePane<Object> getDescendantByContext(GuiMappingContext context)

Parameters:

context - the searched context

Returns:

a descendant value pane holding the context, or null. wrappers which have the same context are avoided.

getDescendantByValue

public GuiSwingView.ValuePane<Object> getDescendantByValue(Object value)

Parameters:

value - the searched value

Returns:

a descendant value pane holding the value, or null. wrappers holding the same context are avoided.

getDescendantByValueIf

public GuiSwingView.ValuePane<Object> getDescendantByValueIf(Predicate<Object> valuePredicate)

Parameters:

valuePredicate - the condition holds the searched value

Returns:

a first descendant value pane holding a value matched by the predicate, or null. wrappers holding the same context are avoided.

getChildByName

public GuiSwingView.ValuePane<Object> getChildByName(String name)

Parameters:

name - the searched context name

Returns:

a child (or descendant for wrappers) value pane holding the named context, or null. wrappers holding the same context are avoided.

getActionByName

public GuiSwingActionDefault.ExecutionAction getActionByName(String name)

getActionByContext

public GuiSwingActionDefault.ExecutionAction getActionByContext(GuiMappingContext context)

getDescendantActionByContext

public GuiSwingActionDefault.ExecutionAction getDescendantActionByContext(GuiMappingContext context)

refreshByContext

public void refreshByContext()

the convenient method for refreshing the pane

Since:

1.5