Module org.autogui

Package org.autogui.swing

Interface GuiSwingView

All Superinterfaces:

GuiSwingElement

All Known Implementing Classes:

GuiSwingViewBooleanCheckBox, GuiSwingViewCollectionTable, GuiSwingViewDocumentEditor, GuiSwingViewEmbeddedComponent, GuiSwingViewEnumComboBox, GuiSwingViewFilePathField, GuiSwingViewImagePane, GuiSwingViewLabel, GuiSwingViewNumberSpinner, GuiSwingViewObjectPane, GuiSwingViewPropertyPane, GuiSwingViewStringField, GuiSwingViewTabbedPane

public interface GuiSwingView
extends GuiSwingElement

the interface for regular pane factory, creating a GuiSwingView.ValuePane.

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static class	GuiSwingView.ContextRefreshAction	an action for refreshing the value of the context of the pane.
static interface	GuiSwingView.SettingsWindowClient	the interface for a client of SettingsWindow implemented by a GuiSwingView.ValuePane.
static interface	GuiSwingView.SpecifierManager	a factory interface for GuiReprValue.ObjectSpecifier
static class	GuiSwingView.SpecifierManagerDefault	a default implementation of specifier-manager: it creates a GuiReprValue.ObjectSpecifier with the parent specifier and caches it.
static class	GuiSwingView.ToStringCopyAction	a general to-string copy action by using GuiRepresentation.toHumanReadableString(GuiMappingContext, Object)
static interface	GuiSwingView.ValuePane<ValueType>	the base mixin interface to a JComponent bound to an object or a property via a context (GuiSwingView.ValuePane.getSwingViewContext()).

Method Summary

Modifier and Type	Method	Description
static <T> T	checkNonNull(Component component, Function<GuiSwingView.ValuePane<Object>,T> f)
static List<GuiSwingView.ValuePane<Object>>	collectChildren(Component component, Predicate<GuiSwingView.ValuePane<Object>> predicate)
static <T extends Component> List<T>	collectComponents(Component component, Class<T> type, Predicate<T> predicate)
static <T> List<T>	collectNonNullByFunction(Component component, Function<GuiSwingView.ValuePane<Object>,T> f)
JComponent	createView(GuiMappingContext context, Supplier<GuiReprValue.ObjectSpecifier> parentSpecifier)
static GuiSwingView.ValuePane<Object>	findChild(Component component, Predicate<GuiSwingView.ValuePane<Object>> predicate)
static <PaneType extends GuiSwingView.ValuePane<?>> PaneType	findChildByType(Component component, Class<PaneType> paneType)
static <T extends Component> T	findComponent(Component component, Class<T> type, Predicate<T> predicate)
static <T> T	findNonNullByFunction(Component component, Function<GuiSwingView.ValuePane<Object>,T> f)
static <T> void	forEach(Class<T> type, Component comp, Consumer<T> f)	recursively traverses components and if a component is an instance of the type, call f.
static GuiSwingActionDefault.ExecutionAction	getActionDefault(GuiSwingView.ValuePane<?> p, Predicate<GuiSwingActionDefault.ExecutionAction> predicate)
static GuiSwingView.ValuePane<Object>	getChild(Component component, Predicate<GuiSwingView.ValuePane<Object>> predicate)
default boolean	isComponentResizable(GuiMappingContext context)
static void	loadChildren(GuiPreferences prefs, JComponent comp)	loadChildren(GuiPreferences, JComponent, GuiSwingPreferences.PrefsApplyOptions) with GuiSwingPreferences.APPLY_OPTIONS_DEFAULT
static void	loadChildren(GuiPreferences prefs, JComponent comp, GuiSwingPreferences.PrefsApplyOptions options)	traverses descendant components and call loadPreferencesDefault(JComponent, GuiPreferences)
static void	loadPreferencesDefault(JComponent pane, GuiPreferences prefs)	loadPreferencesDefault(JComponent, GuiPreferences, GuiSwingPreferences.PrefsApplyOptions) with GuiSwingPreferences.APPLY_OPTIONS_DEFAULT
static void	loadPreferencesDefault(JComponent pane, GuiPreferences prefs, GuiSwingPreferences.PrefsApplyOptions options)	load the current value and history values of the prefs to the pane
static void	prepareForRefresh(GuiSwingView.ValuePane<?> pane)	a refresh-action calls the method in order to clear view-clocks of sub-panes
static void	saveChildren(GuiPreferences prefs, JComponent comp)	traverse descendant components and call GuiSwingView.ValuePane.saveSwingPreferences(GuiPreferences) for each component.
static void	savePreferencesDefault(JComponent pane, GuiPreferences prefs)	save the current value and history values of the pane to given preferences
static void	setDescriptionToolTipText(GuiMappingContext context, JComponent comp)
static void	setLastHistoryValue(GuiPreferences prefs, GuiSwingView.ValuePane<Object> pane)	setLastHistoryValue(GuiPreferences, ValuePane, GuiSwingPreferences.PrefsApplyOptions) with GuiSwingPreferences.APPLY_OPTIONS_DEFAULT
static void	setLastHistoryValue(GuiPreferences prefs, GuiSwingView.ValuePane<Object> pane, GuiSwingPreferences.PrefsApplyOptions options)	obtain GuiPreferences.getCurrentValue() or a last value of GuiPreferences.getHistoryValues() (only when the context GuiMappingContext.isHistoryValueStored(Object) with null), and set the value by GuiSwingView.ValuePane.setSwingViewHistoryValue(Object).
static void	setupCopyAndPasteActions(JComponent component)
static void	setupKeyBindingsForStaticJMenuSubItems(JComponent pane, JMenuItem i, Predicate<Action> overwrite)
static boolean	setupKeyBindingsForStaticMenuItemAction(JComponent pane, Action a, Predicate<Action> overwrite)
static void	setupKeyBindingsForStaticMenuItems(GuiSwingView.ValuePane<?> pane)
static void	setupKeyBindingsForStaticMenuItems(GuiSwingView.ValuePane<?> pane, Predicate<Action> overwrite)
static void	setupKeyBindingsForStaticMenuItems(GuiSwingView.ValuePane<?> pane, JComponent targetPane, Predicate<Action> overwrite)
static void	setupTransferHandler(JComponent component, TransferHandler handler)	set up the transfer handler for a component.
static void	setupTransferHandler(JComponent component, TransferHandler handler, Integer... modifierKeys)
static void	updateFromGui(GuiSwingView.ValuePane<?> pane, Object value, GuiTaskClock viewClock)	send the value to the context of the pane by GuiReprValue.updateFromGui(GuiMappingContext, Object, GuiReprValue.ObjectSpecifier, GuiTaskClock), with copying the clock and the specifier of the pane in the caller's thread.
static void	updateViewClockSync(GuiTaskClock viewClock, GuiMappingContext context)	obtains context clock and set to the viewClock if the viewClock is older: typically used by GuiSwingView.ValuePane.setSwingViewValueWithUpdate(Object)

Method Details

createView

JComponent createView(GuiMappingContext context,
 Supplier<GuiReprValue.ObjectSpecifier> parentSpecifier)

isComponentResizable

default boolean isComponentResizable(GuiMappingContext context)

updateViewClockSync

static void updateViewClockSync(GuiTaskClock viewClock,
 GuiMappingContext context)

obtains context clock and set to the viewClock if the viewClock is older: typically used by GuiSwingView.ValuePane.setSwingViewValueWithUpdate(Object)

Parameters:

viewClock - the changed view-clock

context - this source context

updateFromGui

static void updateFromGui(GuiSwingView.ValuePane<?> pane,
 Object value,
 GuiTaskClock viewClock)

send the value to the context of the pane by GuiReprValue.updateFromGui(GuiMappingContext, Object, GuiReprValue.ObjectSpecifier, GuiTaskClock), with copying the clock and the specifier of the pane in the caller's thread.

Parameters:

pane - the source pane

value - the new value to be sent

viewClock - the view-clock of the value

setDescriptionToolTipText

static void setDescriptionToolTipText(GuiMappingContext context,
 JComponent comp)

forEach

static <T> void forEach(Class<T> type,
 Component comp,
 Consumer<T> f)

recursively traverses components and if a component is an instance of the type, call f.

Type Parameters:

T - any type a component might belong to

Parameters:

type - type for a component

comp - the searched component

f - a process for each found component

setLastHistoryValue

static void setLastHistoryValue(GuiPreferences prefs,
 GuiSwingView.ValuePane<Object> pane)

setLastHistoryValue(GuiPreferences, ValuePane, GuiSwingPreferences.PrefsApplyOptions) with GuiSwingPreferences.APPLY_OPTIONS_DEFAULT

Parameters:

prefs - the source preferences

pane - the target pane

setLastHistoryValue

static void setLastHistoryValue(GuiPreferences prefs,
 GuiSwingView.ValuePane<Object> pane,
 GuiSwingPreferences.PrefsApplyOptions options)

obtain GuiPreferences.getCurrentValue() or a last value of GuiPreferences.getHistoryValues() (only when the context GuiMappingContext.isHistoryValueStored(Object) with null), and set the value by GuiSwingView.ValuePane.setSwingViewHistoryValue(Object).

loadPreferencesDefault(JComponent, GuiPreferences) automatically calls the method.

Parameters:

prefs - the source preferences

pane - the target pane

options - the options

Since:

1.4

saveChildren

static void saveChildren(GuiPreferences prefs,
 JComponent comp)

traverse descendant components and call GuiSwingView.ValuePane.saveSwingPreferences(GuiPreferences) for each component. the root pane calls the method.

Parameters:

prefs - the preferences for the comp

comp - the top component

savePreferencesDefault

static void savePreferencesDefault(JComponent pane,
 GuiPreferences prefs)

save the current value and history values of the pane to given preferences

Parameters:

pane - a GuiSwingView.ValuePane

prefs - a target preferences

loadPreferencesDefault

static void loadPreferencesDefault(JComponent pane,
 GuiPreferences prefs)

loadPreferencesDefault(JComponent, GuiPreferences, GuiSwingPreferences.PrefsApplyOptions) with GuiSwingPreferences.APPLY_OPTIONS_DEFAULT

Parameters:

pane - a target GuiSwingView.ValuePane

prefs - a source preferences

loadPreferencesDefault

static void loadPreferencesDefault(JComponent pane,
 GuiPreferences prefs,
 GuiSwingPreferences.PrefsApplyOptions options)

load the current value and history values of the prefs to the pane

Parameters:

pane - a target GuiSwingView.ValuePane

prefs - a source preferences

options - options for applying

Since:

1.4

loadChildren

static void loadChildren(GuiPreferences prefs,
 JComponent comp)

loadChildren(GuiPreferences, JComponent, GuiSwingPreferences.PrefsApplyOptions) with GuiSwingPreferences.APPLY_OPTIONS_DEFAULT

Parameters:

prefs - a top prefs

comp - a top component

loadChildren

static void loadChildren(GuiPreferences prefs,
 JComponent comp,
 GuiSwingPreferences.PrefsApplyOptions options)

traverses descendant components and call loadPreferencesDefault(JComponent, GuiPreferences)

Parameters:

prefs - a top prefs

comp - a top component

options - options for applying

Since:

1.4

findChildByType

static <PaneType extends GuiSwingView.ValuePane<?>>
PaneType findChildByType(Component component,
 Class<PaneType> paneType)

findChild

static GuiSwingView.ValuePane<Object> findChild(Component component,
 Predicate<GuiSwingView.ValuePane<Object>> predicate)

collectChildren

static List<GuiSwingView.ValuePane<Object>> collectChildren(Component component,
 Predicate<GuiSwingView.ValuePane<Object>> predicate)

getChild

static GuiSwingView.ValuePane<Object> getChild(Component component,
 Predicate<GuiSwingView.ValuePane<Object>> predicate)

findNonNullByFunction

static <T> T findNonNullByFunction(Component component,
 Function<GuiSwingView.ValuePane<Object>,T> f)

collectNonNullByFunction

static <T> List<T> collectNonNullByFunction(Component component,
 Function<GuiSwingView.ValuePane<Object>,T> f)

checkNonNull

static <T> T checkNonNull(Component component,
 Function<GuiSwingView.ValuePane<Object>,T> f)

getActionDefault

static GuiSwingActionDefault.ExecutionAction getActionDefault(GuiSwingView.ValuePane<?> p,
 Predicate<GuiSwingActionDefault.ExecutionAction> predicate)

prepareForRefresh

static void prepareForRefresh(GuiSwingView.ValuePane<?> pane)

a refresh-action calls the method in order to clear view-clocks of sub-panes

Parameters:

pane - a root component

findComponent

static <T extends Component> T findComponent(Component component,
 Class<T> type,
 Predicate<T> predicate)

collectComponents

static <T extends Component> List<T> collectComponents(Component component,
 Class<T> type,
 Predicate<T> predicate)

setupKeyBindingsForStaticMenuItems

static void setupKeyBindingsForStaticMenuItems(GuiSwingView.ValuePane<?> pane)

Parameters:

pane - the method obtains static-methods from the pane. so it needs to be called after building valid menu items.

setupKeyBindingsForStaticMenuItems

static void setupKeyBindingsForStaticMenuItems(GuiSwingView.ValuePane<?> pane,
 Predicate<Action> overwrite)

setupKeyBindingsForStaticMenuItems

static void setupKeyBindingsForStaticMenuItems(GuiSwingView.ValuePane<?> pane,
 JComponent targetPane,
 Predicate<Action> overwrite)

setupKeyBindingsForStaticMenuItemAction

static boolean setupKeyBindingsForStaticMenuItemAction(JComponent pane,
 Action a,
 Predicate<Action> overwrite)

setupKeyBindingsForStaticJMenuSubItems

static void setupKeyBindingsForStaticJMenuSubItems(JComponent pane,
 JMenuItem i,
 Predicate<Action> overwrite)

setupTransferHandler

static void setupTransferHandler(JComponent component,
 TransferHandler handler)

set up the transfer handler for a component. also set up drag-gesture for the COPY operation. if the component is not a JTextComponent, then it sets up copy and paste actions to the action-map, and input key-strokes (Cmd+C and Cmd+V) to the input-map (which will be activated when the component is focusable).

Parameters:

component - the target component

handler - the transfer-handler to be set

setupTransferHandler

static void setupTransferHandler(JComponent component,
 TransferHandler handler,
 Integer... modifierKeys)

Parameters:

component - the target component

handler - the transfer-handler to be set

modifierKeys - KeyEvent.VK_SHIFT, KeyEvent.VK_META, KeyEvent.VK_ALT or KeyEvent.VK_ALT_GRAPH

Since:

1.5

setupCopyAndPasteActions

static void setupCopyAndPasteActions(JComponent component)