Module org.autogui

Package org.autogui.swing

Class GuiSwingRootPane.GuiSwingRootPaneCreator

java.lang.Object

org.autogui.swing.GuiSwingRootPane.GuiSwingRootPaneCreator

Direct Known Subclasses:

GuiSwingWindow.GuiSwingWindowCreator

Enclosing class:

GuiSwingRootPane

public static class GuiSwingRootPane.GuiSwingRootPaneCreator
extends Object

a creator of GuiSwingRootPane, can be obtained by GuiSwingRootPane.creator().

the default settings:

• GuiSwingKeyBinding: obtained by GuiSwingKeyBinding.createWithDefaultExcluded()
• GuiTypeBuilder: the strict-mode obtained by new GuiTypeBuilder()
• logStatus: true, which means it installs a GuiSwingLogManager with redirecting consoles (by GuiSwingRootPane.updateSwingLogManager()), and inserts a status-bar for displaying log-messages
• GuiSwingView: obtained by GuiSwingMapperSet.getDefaultMapperSet()
• SettingsWindow: a new window
• GuiPreferences: nothing, which means automatically sets preferences backed by java.util.prefs.

Field Summary

Fields

Modifier and Type	Field	Description
protected GuiSwingKeyBinding	keyBinding
protected boolean	logStatus
protected GuiSwingPreferences.PrefsApplyOptions	prefsApplyOptions
protected Function<GuiMappingContext,GuiPreferences>	prefsCreator
protected SettingsWindow	settingsWindow
protected GuiTypeBuilder	typeBuilder
protected GuiSwingView	view

Constructor Summary

Constructors

Constructor	Description
GuiSwingRootPaneCreator()

Method Summary

Modifier and Type	Method	Description
GuiSwingRootPane	create(Object o)
GuiSwingRootPane	createWithContext(GuiMappingContext context)
GuiSwingKeyBinding	getKeyBinding()
GuiSwingPreferences.PrefsApplyOptions	getPrefsApplyOptions()
Function<GuiMappingContext,GuiPreferences>	getPrefsCreator()
SettingsWindow	getSettingsWindow()
GuiTypeBuilder	getTypeBuilder()
GuiSwingView	getView()
boolean	isLogStatus()
GuiSwingRootPane.GuiSwingRootPaneCreator	withKeyBinding(GuiSwingKeyBinding keyBinding)
GuiSwingRootPane.GuiSwingRootPaneCreator	withKeyBindingWithoutAutomaticBindings()	set a GuiSwingKeyBinding without automatic bindings created from GuiSwingKeyBinding.createWithoutAutomaticBindings().
GuiSwingRootPane.GuiSwingRootPaneCreator	withLogStatus(boolean enableLog)
GuiSwingRootPane.GuiSwingRootPaneCreator	withLogStatusDisabled()	disable overwriting log-manager and no-insertion of status-bar for displaying logs
GuiSwingRootPane.GuiSwingRootPaneCreator	withPreferences(Function<GuiMappingContext,GuiPreferences> prefsCreator)
GuiSwingRootPane.GuiSwingRootPaneCreator	withPreferencesOnMemory()	set preferences setting function to storing values on memory by GuiPreferences.GuiValueStoreOnMemory
GuiSwingRootPane.GuiSwingRootPaneCreator	withPrefsApplyOptions(GuiSwingPreferences.PrefsApplyOptions prefsApplyOptions)
GuiSwingRootPane.GuiSwingRootPaneCreator	withSettingWindow(SettingsWindow settingsWindow)
GuiSwingRootPane.GuiSwingRootPaneCreator	withTypeBuilder(GuiTypeBuilder typeBuilder)
GuiSwingRootPane.GuiSwingRootPaneCreator	withTypeBuilderRelaxed()	set a type builder of GuiTypeBuilder.GuiTypeBuilderRelaxed
GuiSwingRootPane.GuiSwingRootPaneCreator	withView(GuiSwingView view)

Methods inherited from class java.lang.Object

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

Field Details

keyBinding

protected GuiSwingKeyBinding keyBinding

typeBuilder

protected GuiTypeBuilder typeBuilder

logStatus

protected boolean logStatus

settingsWindow

protected SettingsWindow settingsWindow

view

protected GuiSwingView view

prefsCreator

protected Function<GuiMappingContext,GuiPreferences> prefsCreator

prefsApplyOptions

protected GuiSwingPreferences.PrefsApplyOptions prefsApplyOptions

Since:

1.4

Constructor Details

GuiSwingRootPaneCreator

public GuiSwingRootPaneCreator()

Method Details

withKeyBindingWithoutAutomaticBindings

public GuiSwingRootPane.GuiSwingRootPaneCreator withKeyBindingWithoutAutomaticBindings()

set a GuiSwingKeyBinding without automatic bindings created from GuiSwingKeyBinding.createWithoutAutomaticBindings(). This means that it does not traverse created panes for searching default key-bindings.

It can manually set key-bindings by GuiSwingKeyBinding methods such as GuiSwingKeyBinding.putTraverseHighPrecedence(Class, Predicate, KeyStroke, Consumer) , GuiSwingKeyBinding.putTraverseHighPrecedenceAction(Class, Predicate, KeyStroke, Action) , and GuiSwingKeyBinding.putTraverseHighPrecedencePaneFocus(Class, Predicate, KeyStroke).

Returns:

this

withKeyBinding

public GuiSwingRootPane.GuiSwingRootPaneCreator withKeyBinding(GuiSwingKeyBinding keyBinding)

withTypeBuilderRelaxed

public GuiSwingRootPane.GuiSwingRootPaneCreator withTypeBuilderRelaxed()

set a type builder of GuiTypeBuilder.GuiTypeBuilderRelaxed

Returns:

this

withTypeBuilder

public GuiSwingRootPane.GuiSwingRootPaneCreator withTypeBuilder(GuiTypeBuilder typeBuilder)

withLogStatusDisabled

public GuiSwingRootPane.GuiSwingRootPaneCreator withLogStatusDisabled()

disable overwriting log-manager and no-insertion of status-bar for displaying logs

Returns:

this

withLogStatus

public GuiSwingRootPane.GuiSwingRootPaneCreator withLogStatus(boolean enableLog)

withPreferencesOnMemory

public GuiSwingRootPane.GuiSwingRootPaneCreator withPreferencesOnMemory()

set preferences setting function to storing values on memory by GuiPreferences.GuiValueStoreOnMemory

Returns:

this

withPreferences

public GuiSwingRootPane.GuiSwingRootPaneCreator withPreferences(Function<GuiMappingContext,GuiPreferences> prefsCreator)

withSettingWindow

public GuiSwingRootPane.GuiSwingRootPaneCreator withSettingWindow(SettingsWindow settingsWindow)

withView

public GuiSwingRootPane.GuiSwingRootPaneCreator withView(GuiSwingView view)

withPrefsApplyOptions

public GuiSwingRootPane.GuiSwingRootPaneCreator withPrefsApplyOptions(GuiSwingPreferences.PrefsApplyOptions prefsApplyOptions)

Parameters:

prefsApplyOptions - options

Returns:

this

Since:

1.4

create

public GuiSwingRootPane create(Object o)

createWithContext

public GuiSwingRootPane createWithContext(GuiMappingContext context)

getKeyBinding

public GuiSwingKeyBinding getKeyBinding()

getTypeBuilder

public GuiTypeBuilder getTypeBuilder()

isLogStatus

public boolean isLogStatus()

getSettingsWindow

public SettingsWindow getSettingsWindow()

getView

public GuiSwingView getView()

getPrefsApplyOptions

public GuiSwingPreferences.PrefsApplyOptions getPrefsApplyOptions()

Returns:

options or null (default)

Since:

1.4

getPrefsCreator

public Function<GuiMappingContext,GuiPreferences> getPrefsCreator()