Module org.autogui

Package org.autogui.swing

Class GuiSwingRootPane

java.lang.Object

java.awt.Component

java.awt.Container

javax.swing.JComponent

org.autogui.swing.GuiSwingRootPane

All Implemented Interfaces:

ImageObserver, MenuContainer, Serializable, GuiSwingPreferences.RootView

public class GuiSwingRootPane
extends JComponent
implements GuiSwingPreferences.RootView

the root-pane for object binding panes.

The pane can be created by createForObject(Object), createForObject(Object), or GuiSwingRootPane.GuiSwingRootPaneCreator obtained by creator().

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	GuiSwingRootPane.GuiSwingRootPaneCreator	a creator of GuiSwingRootPane, can be obtained by creator().
static class	GuiSwingRootPane.ShowPreferencesAction
static class	GuiSwingRootPane.WindowCloseAction
static class	GuiSwingRootPane.WindowMenuBuilder
static class	GuiSwingRootPane.WindowMenuMinimizeAction
static class	GuiSwingRootPane.WindowMenuToFromAction
static class	GuiSwingRootPane.WindowMenuZoomAction

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

JComponent.AccessibleJComponent

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 boolean	applicationRoot
protected GuiSwingRootPane.WindowCloseAction	closeAction
protected GuiMappingContext	context
protected GuiSwingPreferences.FileDialogPreferencesUpdater	fileDialogPreferencesUpdater
protected GuiSwingKeyBinding	keyBinding
protected GuiSwingPreferences.WindowPreferencesUpdater	logPreferencesUpdater
protected boolean	logStatus
protected GuiSwingLogManager.GuiSwingLogWindow	logWindow
protected JMenuBar	menuBar
protected JMenu	objectMenu
protected GuiSwingPreferences	preferences
protected GuiSwingPreferences.PrefsApplyMenu	prefsApplyMenu
protected GuiSwingPreferences.PrefsApplyOptions	prefsApplyOptions
protected SettingsWindow	settingsWindow
protected GuiSwingRootPane.ShowPreferencesAction	showPreferencesAction
protected String	title
protected GuiSwingView	view
protected JComponent	viewComponent
protected GuiSwingRootPane.WindowMenuBuilder	windowMenuBuilder

Fields inherited from class javax.swing.JComponent

listenerList, TOOL_TIP_TEXT_KEY, ui, UNDEFINED_CONDITION, WHEN_ANCESTOR_OF_FOCUSED_COMPONENT, WHEN_FOCUSED, WHEN_IN_FOCUSED_WINDOW

Fields inherited from class java.awt.Component

accessibleContext, 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

Constructor Summary

Constructors

Constructor	Description
GuiSwingRootPane(GuiMappingContext context)
GuiSwingRootPane(GuiMappingContext context, GuiSwingView view, GuiSwingKeyBinding keyBinding, boolean logStatus, SettingsWindow settingsWindow)
GuiSwingRootPane(GuiMappingContext context, GuiSwingView view, GuiSwingKeyBinding keyBinding, boolean logStatus, SettingsWindow settingsWindow, GuiSwingPreferences.PrefsApplyOptions prefsApplyOptions)

Method Summary

Modifier and Type	Method	Description
void	cleanUp()	cleaning up the pane and related components.
static GuiSwingRootPane	createForObject(Object o)
static GuiSwingRootPane	createForObjectRelaxed(Object o)
static GuiSwingRootPane.GuiSwingRootPaneCreator	creator()	create and return a creator of root-pane
GuiSwingActionDefault.ExecutionAction	getActionByContext(GuiMappingContext context)
GuiSwingActionDefault.ExecutionAction	getActionByName(String name)
static Frame	getActiveFrame()
GuiSwingView.ValuePane<Object>	getChildByName(String name)
JComponent	getContentPane()
GuiMappingContext	getContext()
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.FileDialogPreferencesUpdater	getFileDialogPreferencesUpdater()
GuiSwingKeyBinding	getKeyBinding()
GuiSwingPreferences.WindowPreferencesUpdater	getLogPreferencesUpdater()
GuiSwingLogManager.GuiSwingLogWindow	getLogWindow()
JMenuBar	getMenuBar()
JMenu	getObjectMenu()
GuiSwingPreferences	getPreferences()
GuiSwingPreferences.PrefsApplyOptions	getPrefsApplyOptions()
SettingsWindow	getSettingsWindow()
String	getTitle()
GuiSwingView	getView()
JComponent	getViewComponent()
GuiSwingView.ValuePane<Object>	getViewValuePane()
GuiSwingRootPane.WindowMenuBuilder	getWindowMenuBuilder()
protected void	init()
protected void	initContextUpdate()
protected void	initFileDialogPrefsUpdater()
protected void	initKeyBinding()
protected void	initLog()
protected void	initMenu()
protected void	initPrefs()
protected void	initPrefsLoad()
protected void	initSettingWindow()
protected GuiSwingLogManager	initSwingLogManager()
protected void	initTitle()
protected void	initToolTipManager()
protected void	initViewComponent()
protected void	initViewComponentSet()
boolean	isApplicationRoot()
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	setContentPane(JComponent comp)
void	setMenuBar(JMenuBar menuBar)
void	setTitle(String title)
void	setupObjectMenu()
static GuiSwingLogManager	updateSwingLogManager()
void	updateSwingViewSourceFromRoot()	notify changes of source values to sub-components the pane and update display, by GuiMappingContext.updateSourceFromRoot() .
void	withError(Runnable r)

Methods inherited from class javax.swing.JComponent

addAncestorListener, addNotify, addVetoableChangeListener, computeVisibleRect, contains, createToolTip, disable, enable, firePropertyChange, firePropertyChange, firePropertyChange, fireVetoableChange, getActionForKeyStroke, getActionMap, getAlignmentX, getAlignmentY, getAncestorListeners, getAutoscrolls, getBaseline, getBaselineResizeBehavior, getBorder, getBounds, getClientProperty, getComponentGraphics, getComponentPopupMenu, getConditionForKeyStroke, getDebugGraphicsOptions, getDefaultLocale, getFontMetrics, getGraphics, getHeight, getInheritsPopupMenu, getInputMap, getInputMap, getInputVerifier, getInsets, getInsets, getListeners, getLocation, getMaximumSize, getMinimumSize, getNextFocusableComponent, getPopupLocation, getPreferredSize, getRegisteredKeyStrokes, getRootPane, getSize, getToolTipLocation, getToolTipText, getToolTipText, getTopLevelAncestor, getTransferHandler, getUI, getUIClassID, getVerifyInputWhenFocusTarget, getVetoableChangeListeners, getVisibleRect, getWidth, getX, getY, grabFocus, hide, isDoubleBuffered, isLightweightComponent, isManagingFocus, isOpaque, isOptimizedDrawingEnabled, isPaintingForPrint, isPaintingOrigin, isPaintingTile, isRequestFocusEnabled, isValidateRoot, paint, paintBorder, paintChildren, paintComponent, paintImmediately, paintImmediately, paramString, print, printAll, printBorder, printChildren, printComponent, processComponentKeyEvent, processKeyBinding, processKeyEvent, processMouseEvent, processMouseMotionEvent, putClientProperty, registerKeyboardAction, registerKeyboardAction, removeAncestorListener, removeNotify, removeVetoableChangeListener, repaint, repaint, requestDefaultFocus, requestFocus, requestFocus, requestFocusInWindow, requestFocusInWindow, resetKeyboardActions, reshape, revalidate, scrollRectToVisible, setActionMap, setAlignmentX, setAlignmentY, setAutoscrolls, setBackground, setBorder, setComponentPopupMenu, setDebugGraphicsOptions, setDefaultLocale, setDoubleBuffered, setEnabled, setFocusTraversalKeys, setFont, setForeground, setInheritsPopupMenu, setInputMap, setInputVerifier, setMaximumSize, setMinimumSize, setNextFocusableComponent, setOpaque, setPreferredSize, setRequestFocusEnabled, setToolTipText, setTransferHandler, setUI, setVerifyInputWhenFocusTarget, setVisible, unregisterKeyboardAction, update, updateUI

Methods inherited from class java.awt.Container

add, add, add, add, add, addContainerListener, addImpl, addPropertyChangeListener, addPropertyChangeListener, applyComponentOrientation, areFocusTraversalKeysSet, countComponents, deliverEvent, doLayout, findComponentAt, findComponentAt, getComponent, getComponentAt, getComponentAt, getComponentCount, getComponents, getComponentZOrder, getContainerListeners, getFocusTraversalKeys, getFocusTraversalPolicy, getLayout, getMousePosition, insets, invalidate, isAncestorOf, isFocusCycleRoot, isFocusCycleRoot, isFocusTraversalPolicyProvider, isFocusTraversalPolicySet, layout, list, list, locate, minimumSize, paintComponents, preferredSize, printComponents, processContainerEvent, processEvent, remove, remove, removeAll, removeContainerListener, setComponentZOrder, setFocusCycleRoot, setFocusTraversalPolicy, setFocusTraversalPolicyProvider, setLayout, 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, createImage, createImage, createVolatileImage, createVolatileImage, disableEvents, dispatchEvent, enable, enableEvents, enableInputMethods, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, getAccessibleContext, getBackground, getBounds, getColorModel, getComponentListeners, getComponentOrientation, getCursor, getDropTarget, getFocusCycleRootAncestor, getFocusListeners, getFocusTraversalKeysEnabled, getFont, getForeground, getGraphicsConfiguration, getHierarchyBoundsListeners, getHierarchyListeners, getIgnoreRepaint, getInputContext, getInputMethodListeners, getInputMethodRequests, getKeyListeners, getLocale, getLocation, getLocationOnScreen, getMouseListeners, getMouseMotionListeners, getMousePosition, getMouseWheelListeners, getName, getParent, getPropertyChangeListeners, getPropertyChangeListeners, getSize, getToolkit, getTreeLock, gotFocus, handleEvent, hasFocus, imageUpdate, inside, isBackgroundSet, isCursorSet, isDisplayable, isEnabled, isFocusable, isFocusOwner, isFocusTraversable, isFontSet, isForegroundSet, isLightweight, isMaximumSizeSet, isMinimumSizeSet, isPreferredSizeSet, isShowing, isValid, isVisible, keyDown, keyUp, list, list, list, location, lostFocus, mouseDown, mouseDrag, mouseEnter, mouseExit, mouseMove, mouseUp, move, nextFocus, paintAll, postEvent, prepareImage, prepareImage, processComponentEvent, processFocusEvent, processHierarchyBoundsEvent, processHierarchyEvent, processInputMethodEvent, processMouseWheelEvent, remove, removeComponentListener, removeFocusListener, removeHierarchyBoundsListener, removeHierarchyListener, removeInputMethodListener, removeKeyListener, removeMouseListener, removeMouseMotionListener, removeMouseWheelListener, removePropertyChangeListener, removePropertyChangeListener, repaint, repaint, repaint, requestFocus, requestFocus, requestFocusInWindow, resize, resize, setBounds, setBounds, setComponentOrientation, setCursor, setDropTarget, setFocusable, setFocusTraversalKeysEnabled, setIgnoreRepaint, setLocale, setLocation, setLocation, setMixingCutoutShape, setName, setSize, setSize, show, 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

Field Details

context

protected GuiMappingContext context

view

protected GuiSwingView view

preferences

protected GuiSwingPreferences preferences

logWindow

protected GuiSwingLogManager.GuiSwingLogWindow logWindow

logStatus

protected boolean logStatus

viewComponent

protected JComponent viewComponent

objectMenu

protected JMenu objectMenu

windowMenuBuilder

protected GuiSwingRootPane.WindowMenuBuilder windowMenuBuilder

logPreferencesUpdater

protected GuiSwingPreferences.WindowPreferencesUpdater logPreferencesUpdater

fileDialogPreferencesUpdater

protected GuiSwingPreferences.FileDialogPreferencesUpdater fileDialogPreferencesUpdater

settingsWindow

protected SettingsWindow settingsWindow

applicationRoot

protected boolean applicationRoot

keyBinding

protected GuiSwingKeyBinding keyBinding

title

protected String title

menuBar

protected JMenuBar menuBar

showPreferencesAction

protected GuiSwingRootPane.ShowPreferencesAction showPreferencesAction

prefsApplyMenu

protected GuiSwingPreferences.PrefsApplyMenu prefsApplyMenu

closeAction

protected GuiSwingRootPane.WindowCloseAction closeAction

prefsApplyOptions

protected GuiSwingPreferences.PrefsApplyOptions prefsApplyOptions

Since:

1.4

Constructor Details

GuiSwingRootPane

public GuiSwingRootPane(GuiMappingContext context)

GuiSwingRootPane

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

Throws:

HeadlessException

GuiSwingRootPane

public GuiSwingRootPane(GuiMappingContext context,
 GuiSwingView view,
 GuiSwingKeyBinding keyBinding,
 boolean logStatus,
 SettingsWindow settingsWindow,
 GuiSwingPreferences.PrefsApplyOptions prefsApplyOptions)
                 throws HeadlessException

Parameters:

context - the context

view - the view

keyBinding - the key-binding

logStatus - the flat for showing log-status

settingsWindow - the setting window

prefsApplyOptions - the options for prefs application

Throws:

HeadlessException - if the runtime is headless

Since:

1.4

Method Details

createForObject

public static GuiSwingRootPane createForObject(Object o)

Parameters:

o - the root bound object

Returns:

a root-pane with strict member binding

createForObjectRelaxed

public static GuiSwingRootPane createForObjectRelaxed(Object o)

Parameters:

o - the root bound object

Returns:

a root-pane with relaxed member binding by GuiSwingRootPane.GuiSwingRootPaneCreator.withTypeBuilderRelaxed()

creator

public static GuiSwingRootPane.GuiSwingRootPaneCreator creator()

create and return a creator of root-pane

     GuiSwingRootPane.creator()
       .withTypeBuilderRelaxed()
       .create(o);
 

Returns:

a new creator

getContext

public GuiMappingContext getContext()

Specified by:

getContext in interface GuiSwingPreferences.RootView

getViewComponent

public JComponent getViewComponent()

Specified by:

getViewComponent in interface GuiSwingPreferences.RootView

init

protected void init()

initTitle

protected void initTitle()

initToolTipManager

protected void initToolTipManager()

initViewComponent

protected void initViewComponent()

initKeyBinding

protected void initKeyBinding()

initViewComponentSet

protected void initViewComponentSet()

initPrefs

protected void initPrefs()

initMenu

protected void initMenu()

setupObjectMenu

public void setupObjectMenu()

initLog

protected void initLog()

initSwingLogManager

protected GuiSwingLogManager initSwingLogManager()

updateSwingLogManager

public static GuiSwingLogManager updateSwingLogManager()

initFileDialogPrefsUpdater

protected void initFileDialogPrefsUpdater()

initContextUpdate

protected void initContextUpdate()

initPrefsLoad

protected void initPrefsLoad()

initSettingWindow

protected void initSettingWindow()

setTitle

public void setTitle(String title)

getTitle

public String getTitle()

setMenuBar

public void setMenuBar(JMenuBar menuBar)

getMenuBar

public JMenuBar getMenuBar()

setContentPane

public void setContentPane(JComponent comp)

getContentPane

public JComponent getContentPane()

getView

public GuiSwingView getView()

getLogWindow

public GuiSwingLogManager.GuiSwingLogWindow getLogWindow()

getObjectMenu

public JMenu getObjectMenu()

getWindowMenuBuilder

public GuiSwingRootPane.WindowMenuBuilder getWindowMenuBuilder()

getLogPreferencesUpdater

public GuiSwingPreferences.WindowPreferencesUpdater getLogPreferencesUpdater()

getFileDialogPreferencesUpdater

public GuiSwingPreferences.FileDialogPreferencesUpdater getFileDialogPreferencesUpdater()

getSettingsWindow

public SettingsWindow getSettingsWindow()

getKeyBinding

public GuiSwingKeyBinding getKeyBinding()

isApplicationRoot

public boolean isApplicationRoot()

setApplicationRoot

public void setApplicationRoot(boolean applicationRoot)

getPrefsApplyOptions

public GuiSwingPreferences.PrefsApplyOptions getPrefsApplyOptions()

Returns:

options

Since:

1.4

cleanUp

public void cleanUp()

cleaning up the pane and related components. the owner window should call the method before closing (disposing) the window.

The method does not intend to reuse the pane after cleaning up.

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)

withError

public void withError(Runnable r)

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)

updateSwingViewSourceFromRoot

public void updateSwingViewSourceFromRoot()

notify changes of source values to sub-components the pane and update display, by GuiMappingContext.updateSourceFromRoot() .

Since:

1.1

refreshByContext

public void refreshByContext()

the convenient method for refreshing the pane

Since:

1.5

getActiveFrame

public static Frame getActiveFrame()