Module org.autogui

Package org.autogui.swing

Class GuiSwingViewDocumentEditor

java.lang.Object

org.autogui.swing.GuiSwingViewDocumentEditor

All Implemented Interfaces:

GuiSwingElement, GuiSwingView

public class GuiSwingViewDocumentEditor
extends Object
implements GuiSwingView

a swing view for GuiReprValueDocumentEditor

swing-value

GuiSwingViewDocumentEditor.PropertyDocumentEditorPane.getSwingViewValue() or GuiSwingViewDocumentEditor.PropertyDocumentTextPane.getSwingViewValue(): Document, AbstractDocument.Content, StringBuilder, or SwingDeferredRunner.TaskResultFuture handled by GuiReprValueDocumentEditor.toUpdateValue(GuiMappingContext, Object, Consumer)

• setting to the value is processed by setSwingViewValue(JEditorPane, GuiSwingView.SpecifierManager, GuiMappingContext, Object, boolean, GuiTaskClock). it calls GuiReprValueDocumentEditor.toUpdateValue(GuiMappingContext, Object, Consumer). if the given value is a SwingDeferredRunner.TaskResultFuture,. it immediately obtains the result value as a Document by re-run toUpdateValue with the value of the future, or returns null with runs a delayed task.
• For another non-Document value, toUpdateValue returns a Document wrapping the value
• As the delayed task, setSwingViewValueDocument(JEditorPane, GuiSwingView.SpecifierManager, GuiMappingContext, Object, Document, boolean, GuiTaskClock). is used. the method updates Document of the pane by JTextComponent.setDocument(Document) and calls GuiSwingView.updateFromGui(ValuePane, Object, GuiTaskClock) (if contextUpdate=true)

history-value

TODO unsupported yet

string-transfer

TODO unsupported yet

preferences

     {
         "lineSpacing": Number,
         "spaceAbove": Number,
         "fontFamily": String,
         "fontSize": Number,
         "bold": Boolean,
         "italic": Boolean,
         "backgroundColor": "[intR, intG, intB, intA]",
         "foregroundColor": "[intR, intG, intB, intA]",
         "backgroundCustom": Boolean,
         "foregroundCustom": Boolean,
         "wrapText": Boolean
     }
 

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	GuiSwingViewDocumentEditor.DocumentSettingAction
static class	GuiSwingViewDocumentEditor.DocumentSettingPane	a setting pane for document default stype; a GUI for GuiSwingViewDocumentEditor.PreferencesForDocumentSetting
static class	GuiSwingViewDocumentEditor.PopupButtonListener
static class	GuiSwingViewDocumentEditor.PreferencesForDocumentSetting	prefs obj for document-settings; currently the settings have properties of entire document styling only for editing plain-texts; minimize properties.
static class	GuiSwingViewDocumentEditor.PropertyDocumentEditorPane
static class	GuiSwingViewDocumentEditor.PropertyDocumentTextPane
static class	GuiSwingViewDocumentEditor.SelectionHighlightPainter
static class	GuiSwingViewDocumentEditor.StyleSetAction
static class	GuiSwingViewDocumentEditor.TextPaneInitializer
static interface	GuiSwingViewDocumentEditor.WrapLineSupport	the interface for the target pane of GuiSwingViewDocumentEditor.DocumentSettingPane; if the pane implements the interface, it will be called at updating the wrapping-line property from the setting pane.

Nested classes/interfaces inherited from interface org.autogui.swing.GuiSwingView

GuiSwingView.ContextRefreshAction, GuiSwingView.SettingsWindowClient, GuiSwingView.SpecifierManager, GuiSwingView.SpecifierManagerDefault, GuiSwingView.ToStringCopyAction, GuiSwingView.ValuePane<ValueType>

Field Summary

Fields

Modifier and Type	Field	Description
static final int	DOCUMENT_SETTING_PANE_FONT_SIZE_MAX
static final int	DOCUMENT_SETTING_PANE_FONT_SIZE_MIN
static final double	DOCUMENT_SETTING_PANE_SPACE_ABOBE_MAX
static final double	DOCUMENT_SETTING_PANE_SPACE_ABOBE_MIN
static final double	DOCUMENT_SETTING_PANE_SPACE_LINE_MAX
static final double	DOCUMENT_SETTING_PANE_SPACE_LINE_MIN

Constructor Summary

Constructors

Constructor	Description
GuiSwingViewDocumentEditor()

Method Summary

Modifier and Type	Method	Description
JComponent	createView(GuiMappingContext context, Supplier<GuiReprValue.ObjectSpecifier> parentSpecifier)
static Dimension	getPreferredSize(JTextComponent field, boolean wrapLine)
static Dimension	getPreferredSizeWithParentScrollWrapLine(JTextComponent field)	an implementation for JComponent.getPreferredSize() supporting wrapping-line; checks the horizontal policy of parent JScrollPane by isWrapLine(JScrollPane) and calls getPreferredSize(JTextComponent, boolean).
static boolean	getScrollableTracksViewportWidth(JTextComponent field)	an implementation for JTextComponent.getScrollableTracksViewportWidth()
static Object	getSwingViewValue(JEditorPane pane, GuiMappingContext context)
static List<PopupCategorized.CategorizedMenuItem>	getTextMenuItems(GuiSwingView.ValuePane<?> pane, MenuBuilder.MenuLabel infoLabel)
boolean	isComponentResizable(GuiMappingContext context)
static boolean	isWrapLine(JScrollPane pane)
static boolean	isWrapLineNotMatch(JScrollPane pane, boolean tested)
static JScrollPane	scrollPane(JComponent c)
static JScrollPane	scrollPaneContainer(Container c)
static void	setSwingViewValue(JEditorPane pane, GuiSwingView.SpecifierManager specifierManager, GuiMappingContext context, Object newValue, boolean contextUpdate, GuiTaskClock viewClock)
static void	setSwingViewValueDocument(JEditorPane pane, GuiSwingView.SpecifierManager specifierManager, GuiMappingContext context, Object newValue, Document doc, boolean contextUpdate, GuiTaskClock viewClock)
static void	setWrapLine(JScrollPane pane, boolean f)

Methods inherited from class java.lang.Object

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

Field Details

DOCUMENT_SETTING_PANE_SPACE_ABOBE_MIN

public static final double DOCUMENT_SETTING_PANE_SPACE_ABOBE_MIN

See Also:

• Constant Field Values

DOCUMENT_SETTING_PANE_SPACE_ABOBE_MAX

public static final double DOCUMENT_SETTING_PANE_SPACE_ABOBE_MAX

See Also:

• Constant Field Values

DOCUMENT_SETTING_PANE_SPACE_LINE_MIN

public static final double DOCUMENT_SETTING_PANE_SPACE_LINE_MIN

See Also:

• Constant Field Values

DOCUMENT_SETTING_PANE_SPACE_LINE_MAX

public static final double DOCUMENT_SETTING_PANE_SPACE_LINE_MAX

See Also:

• Constant Field Values

DOCUMENT_SETTING_PANE_FONT_SIZE_MIN

public static final int DOCUMENT_SETTING_PANE_FONT_SIZE_MIN

See Also:

• Constant Field Values

DOCUMENT_SETTING_PANE_FONT_SIZE_MAX

public static final int DOCUMENT_SETTING_PANE_FONT_SIZE_MAX

See Also:

• Constant Field Values

Constructor Details

GuiSwingViewDocumentEditor

public GuiSwingViewDocumentEditor()

Method Details

createView

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

Specified by:

createView in interface GuiSwingView

isComponentResizable

public boolean isComponentResizable(GuiMappingContext context)

Specified by:

isComponentResizable in interface GuiSwingView

getTextMenuItems

public static List<PopupCategorized.CategorizedMenuItem> getTextMenuItems(GuiSwingView.ValuePane<?> pane,
 MenuBuilder.MenuLabel infoLabel)

setSwingViewValue

public static void setSwingViewValue(JEditorPane pane,
 GuiSwingView.SpecifierManager specifierManager,
 GuiMappingContext context,
 Object newValue,
 boolean contextUpdate,
 GuiTaskClock viewClock)

setSwingViewValueDocument

public static void setSwingViewValueDocument(JEditorPane pane,
 GuiSwingView.SpecifierManager specifierManager,
 GuiMappingContext context,
 Object newValue,
 Document doc,
 boolean contextUpdate,
 GuiTaskClock viewClock)

getSwingViewValue

public static Object getSwingViewValue(JEditorPane pane,
 GuiMappingContext context)

Parameters:

pane - the pane of the document

context - the context of the view.

Returns:

always return a Document

getPreferredSizeWithParentScrollWrapLine

public static Dimension getPreferredSizeWithParentScrollWrapLine(JTextComponent field)

an implementation for JComponent.getPreferredSize() supporting wrapping-line; checks the horizontal policy of parent JScrollPane by isWrapLine(JScrollPane) and calls getPreferredSize(JTextComponent, boolean). A text-component can support wrapping-line by overriding JComponent.getPreferredSize() and JTextComponent.getScrollableTracksViewportWidth() with this method and getScrollableTracksViewportWidth(JTextComponent).

Parameters:

field - the target text-component

Returns:

the preferred-size suitable for the current wrapping-line setting

Since:

1.7

See Also:

• getScrollableTracksViewportWidth(JTextComponent)

getScrollableTracksViewportWidth

public static boolean getScrollableTracksViewportWidth(JTextComponent field)

an implementation for JTextComponent.getScrollableTracksViewportWidth()

Parameters:

field - the target text-component

Returns:

true if isWrapLine(JScrollPane) of the parent of the field

Since:

1.7

getPreferredSize

public static Dimension getPreferredSize(JTextComponent field,
 boolean wrapLine)

scrollPane

public static JScrollPane scrollPane(JComponent c)

Parameters:

c - the text-component

Returns:

the parent scroll-pane by calling scrollPaneContainer(Container) with the parent

Since:

1.7

scrollPaneContainer

public static JScrollPane scrollPaneContainer(Container c)

Parameters:

c - the parent container of a text-comonent

Returns:

an upper scroll-pane

isWrapLine

public static boolean isWrapLine(JScrollPane pane)

Parameters:

pane - a scroll-pane or null

Returns:

true if null or horizontal-scroll-bar-policy not "always"; i.e. "never" or "as_needed"

isWrapLineNotMatch

public static boolean isWrapLineNotMatch(JScrollPane pane,
 boolean tested)

Parameters:

pane - a scroll-pane or null

tested - the tested wrapping-line property

Returns:

true if the horizonta-scroll-bar-policy is not the tested value; if true, it should update the wrapping-line property and revalidate the layout.

setWrapLine

public static void setWrapLine(JScrollPane pane,
 boolean f)

Parameters:

pane - the target pane

f - the new property value of wrapping-line

Since:

1.7