Module org.autogui

Package org.autogui.swing

Class GuiSwingViewDocumentEditor.DocumentSettingPane

java.lang.Object

java.awt.Component

java.awt.Container

javax.swing.JComponent

javax.swing.JPanel

org.autogui.swing.GuiSwingViewDocumentEditor.DocumentSettingPane

All Implemented Interfaces:

ImageObserver, MenuContainer, Serializable, Accessible, GuiSwingPrefsSupports.Preferences

Enclosing class:

GuiSwingViewDocumentEditor

public static class GuiSwingViewDocumentEditor.DocumentSettingPane
extends JPanel
implements GuiSwingPrefsSupports.Preferences

a setting pane for document default stype; a GUI for GuiSwingViewDocumentEditor.PreferencesForDocumentSetting

See Also:

• Serialized Form

Nested Class Summary

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

JPanel.AccessibleJPanel

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 SettingsWindow.ColorButton	backgroundColor
protected JCheckBox	backgroundCustom
protected JComboBox<String>	fontFamily
protected JSpinner	fontSize
protected SettingsWindow.ColorButton	foregroundColor
protected JCheckBox	foregroundCustom
protected JEditorPane	pane
protected Consumer<GuiSwingViewDocumentEditor.PreferencesForDocumentSetting>	preferencesUpdater
protected GuiSwingViewDocumentEditor.PreferencesForDocumentSetting	prefsObj
protected JSpinner	spaceAbove
protected JSpinner	spaceLine
protected JToggleButton	styleBold
protected JToggleButton	styleItalic
protected JToggleButton	styleWrapLine
protected boolean	updateDisabled

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
DocumentSettingPane(JEditorPane pane)

Method Summary

Modifier and Type	Method	Description
SettingsWindow.ColorButton	getBackgroundColor()
JCheckBox	getBackgroundCustom()
JComboBox<String>	getFontFamily()
JSpinner	getFontSize()
SettingsWindow.ColorButton	getForegroundColor()
JCheckBox	getForegroundCustom()
JEditorPane	getPane()
GuiSwingViewDocumentEditor.PreferencesForDocumentSetting	getPrefsObj()
JSpinner	getSpaceAbove()
JSpinner	getSpaceLine()
JToggleButton	getStyleBold()
JToggleButton	getStyleItalic()
JToggleButton	getStyleWrapLine()
void	init()
void	initBorder()
void	initColor()
void	initFontFamily()
void	initFontSize()
void	initLayout()
void	initListener()	setting-up listeners of GUI settings ; the style will be immediately reflected by an UI action.
void	initPrefsObj()	initialize GuiSwingViewDocumentEditor.PreferencesForDocumentSetting with default (non-null) values; also if it has a target text-pane, calls GuiSwingViewDocumentEditor.PreferencesForDocumentSetting.setup(JComponent) for reading from the pane settings and set those values to the prefsObj.
void	initSpace()
void	initStyle()
void	initTimerForAfterRendering()	called from initListener() and starts an one-shot UI timer for updateGuiAndPrefsObjFromTargetTextPane(); intended to update the setting props from the target-pane after displaying it.
boolean	loadFromAndChanged(GuiPreferences prefs)
static Consumer<GuiSwingViewDocumentEditor.PreferencesForDocumentSetting>	preferencesUpdaterForEventListener(JComponent pane, Consumer<GuiSwingPrefsSupports.PreferencesUpdateEvent> eventListener)
void	saveTo(GuiPreferences prefs)
void	selectFontFamily(ItemEvent e)
void	sendPreferences()
void	setFrom(GuiSwingViewDocumentEditor.PreferencesForDocumentSetting prefsObj)	update the GUI-settings props by reading the prefsObj
void	setPreferencesUpdater(Consumer<GuiSwingViewDocumentEditor.PreferencesForDocumentSetting> updater)
void	setPreferencesUpdaterEventListener(Consumer<GuiSwingPrefsSupports.PreferencesUpdateEvent> eventListener)
void	setTo(GuiSwingViewDocumentEditor.PreferencesForDocumentSetting prefsObj)	update the prefsObj by current GUI-settings props
void	shutDown()
void	styleChanged(ChangeEvent e)
void	updateGuiAndPrefsObjFromTargetTextPane()
void	updateGuiAndTargetTextPaneFromPrefsObj()
void	updateTargetTextPaneAndPrefsObjFromGui()	update style from GUI; calls updateTargetTextPaneAndPrefsObjFromGuiBody()
void	updateTargetTextPaneAndPrefsObjFromGuiBody()

Methods inherited from class javax.swing.JPanel

getAccessibleContext, getUI, getUIClassID, paramString, setUI, updateUI

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, getVerifyInputWhenFocusTarget, getVetoableChangeListeners, getVisibleRect, getWidth, getX, getY, grabFocus, hide, isDoubleBuffered, isLightweightComponent, isManagingFocus, isOpaque, isOptimizedDrawingEnabled, isPaintingForPrint, isPaintingOrigin, isPaintingTile, isRequestFocusEnabled, isValidateRoot, paint, paintBorder, paintChildren, paintComponent, paintImmediately, paintImmediately, 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

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, 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.prefs.GuiSwingPrefsSupports.Preferences

loadFrom

Field Details

pane

protected JEditorPane pane

fontFamily

protected JComboBox<String> fontFamily

styleBold

protected JToggleButton styleBold

styleItalic

protected JToggleButton styleItalic

styleWrapLine

protected JToggleButton styleWrapLine

fontSize

protected JSpinner fontSize

spaceAbove

protected JSpinner spaceAbove

spaceLine

protected JSpinner spaceLine

foregroundCustom

protected JCheckBox foregroundCustom

Since:

1.2

foregroundColor

protected SettingsWindow.ColorButton foregroundColor

backgroundCustom

protected JCheckBox backgroundCustom

Since:

1.2

backgroundColor

protected SettingsWindow.ColorButton backgroundColor

updateDisabled

protected boolean updateDisabled

preferencesUpdater

protected Consumer<GuiSwingViewDocumentEditor.PreferencesForDocumentSetting> preferencesUpdater

prefsObj

protected GuiSwingViewDocumentEditor.PreferencesForDocumentSetting prefsObj

Constructor Details

DocumentSettingPane

public DocumentSettingPane(JEditorPane pane)

Method Details

init

public void init()

initBorder

public void initBorder()

initFontFamily

public void initFontFamily()

initStyle

public void initStyle()

initFontSize

public void initFontSize()

initSpace

public void initSpace()

initColor

public void initColor()

initLayout

public void initLayout()

initPrefsObj

public void initPrefsObj()

initialize GuiSwingViewDocumentEditor.PreferencesForDocumentSetting with default (non-null) values; also if it has a target text-pane, calls GuiSwingViewDocumentEditor.PreferencesForDocumentSetting.setup(JComponent) for reading from the pane settings and set those values to the prefsObj. The GUI of the setting-pane is updated by the prefsObj

initListener

public void initListener()

setting-up listeners of GUI settings ; the style will be immediately reflected by an UI action.

initTimerForAfterRendering

public void initTimerForAfterRendering()

called from initListener() and starts an one-shot UI timer for updateGuiAndPrefsObjFromTargetTextPane(); intended to update the setting props from the target-pane after displaying it.

selectFontFamily

public void selectFontFamily(ItemEvent e)

styleChanged

public void styleChanged(ChangeEvent e)

updateTargetTextPaneAndPrefsObjFromGui

public void updateTargetTextPaneAndPrefsObjFromGui()

update style from GUI; calls updateTargetTextPaneAndPrefsObjFromGuiBody()

updateTargetTextPaneAndPrefsObjFromGuiBody

public void updateTargetTextPaneAndPrefsObjFromGuiBody()

setTo

public void setTo(GuiSwingViewDocumentEditor.PreferencesForDocumentSetting prefsObj)

update the prefsObj by current GUI-settings props

Parameters:

prefsObj - the updated prefsObj

setFrom

public void setFrom(GuiSwingViewDocumentEditor.PreferencesForDocumentSetting prefsObj)

update the GUI-settings props by reading the prefsObj

Parameters:

prefsObj - the source prefsObj

setPreferencesUpdaterEventListener

public void setPreferencesUpdaterEventListener(Consumer<GuiSwingPrefsSupports.PreferencesUpdateEvent> eventListener)

setPreferencesUpdater

public void setPreferencesUpdater(Consumer<GuiSwingViewDocumentEditor.PreferencesForDocumentSetting> updater)

preferencesUpdaterForEventListener

public static Consumer<GuiSwingViewDocumentEditor.PreferencesForDocumentSetting> preferencesUpdaterForEventListener(JComponent pane,
 Consumer<GuiSwingPrefsSupports.PreferencesUpdateEvent> eventListener)

sendPreferences

public void sendPreferences()

updateGuiAndPrefsObjFromTargetTextPane

public void updateGuiAndPrefsObjFromTargetTextPane()

updateGuiAndTargetTextPaneFromPrefsObj

public void updateGuiAndTargetTextPaneFromPrefsObj()

shutDown

public void shutDown()

getFontFamily

public JComboBox<String> getFontFamily()

getStyleBold

public JToggleButton getStyleBold()

getStyleItalic

public JToggleButton getStyleItalic()

getStyleWrapLine

public JToggleButton getStyleWrapLine()

getFontSize

public JSpinner getFontSize()

getSpaceAbove

public JSpinner getSpaceAbove()

getSpaceLine

public JSpinner getSpaceLine()

getForegroundCustom

public JCheckBox getForegroundCustom()

Returns:

the backgroundCustom checkbox

Since:

1.2

getForegroundColor

public SettingsWindow.ColorButton getForegroundColor()

getBackgroundCustom

public JCheckBox getBackgroundCustom()

Returns:

the foregroundCustom checkbox

Since:

1.2

getBackgroundColor

public SettingsWindow.ColorButton getBackgroundColor()

loadFromAndChanged

public boolean loadFromAndChanged(GuiPreferences prefs)

Specified by:

loadFromAndChanged in interface GuiSwingPrefsSupports.Preferences

Parameters:

prefs - the laoding source

Returns:

true if a part of the preferences is actually changed

saveTo

public void saveTo(GuiPreferences prefs)

Specified by:

saveTo in interface GuiSwingPrefsSupports.Preferences

getPane

public JEditorPane getPane()

getPrefsObj

public GuiSwingViewDocumentEditor.PreferencesForDocumentSetting getPrefsObj()