Module org.autogui

Package org.autogui.swing

Class GuiSwingViewDocumentEditor.PreferencesForDocumentSetting

java.lang.Object

org.autogui.swing.GuiSwingViewDocumentEditor.PreferencesForDocumentSetting

All Implemented Interfaces:

GuiSwingPrefsSupports.Preferences

Enclosing class:

GuiSwingViewDocumentEditor

public static class GuiSwingViewDocumentEditor.PreferencesForDocumentSetting
extends Object
implements GuiSwingPrefsSupports.Preferences

prefs obj for document-settings; currently the settings have properties of entire document styling only for editing plain-texts; minimize properties. Currently supports the following properties;

• float lineSpacing: the factor of spaces between lines. StyleConstants.LineSpacing
• float spaceAbove: points of spaces before the paragraph. StyleConstants.SpaceAbove
• String fontFamily: the name of the font. StyleConstants.FontFamily
• int fontSize: points of the font. StyleConstants.FontSize
• boolean bold: font-style bold. StyleConstants.Bold
• boolean italic: font-style italic. StyleConstants.Italic
• boolean backgroundCustom: the flag for enabling backgroundColor
• boolean foregroundCustom: the flag for enabling foregroundColor
• Color backgroundColor: the background color. available only if backgroundCustom=true. StyleConstants.Background
• Color foreground: the text color. available only if foregrooundCustom=true. StyleConstants.Foreground
• boolean wrapText: the flag for wrapping-line; can be implemented by horizontal-scroll-bar-policy and preferred-size

Since:

1.7

Field Summary

Fields

Modifier and Type	Field	Description
protected boolean	allowNullValues
protected Color	backgroundColor
protected boolean	backgroundCustom
protected boolean	bold
static final String	DEFAULT_FONT_FAMILY
static final int	DEFAULT_NUM
protected Color	defaultBackground
protected Color	defaultForeground
protected String	fontFamily
protected int	fontSize
protected Color	foregroundColor
protected boolean	foregroundCustom
protected boolean	italic
static final String	KEY_BACKGROUND_COLOR
static final String	KEY_BACKGROUND_CUSTOM
static final String	KEY_BOLD
static final String	KEY_FONT_FAMILY
static final String	KEY_FONT_SIZE
static final String	KEY_FOREGROUND_COLOR
static final String	KEY_FOREGROUND_CUSTOM
static final String	KEY_ITALIC
static final String	KEY_LINE_SPACING
static final String	KEY_SPACE_ABOVE
static final String	KEY_WRAP_TEXT
protected float	lineSpacing
protected float	spaceAbove
protected boolean	wrapText

Constructor Summary

Constructors

Constructor	Description
PreferencesForDocumentSetting()	initialize by null-values and black and white colors.
PreferencesForDocumentSetting(JEditorPane pane)	initialize with the target pane (or if null, it sets default null values).

Method Summary

Modifier and Type	Method	Description
void	applyTo(JComponent pane)	set style of the target-text-pane by getTargetStyle(JComponent) and applyTo(MutableAttributeSet) ,applyToDocument(StyledDocument, MutableAttributeSet) and applyToComponentWithoutDocument(JComponent).
void	applyTo(MutableAttributeSet style)	update the target style by properties of the prefs, or if remove attributes by null-values
void	applyToComponentWithoutDocument(JComponent pane)	set the background and foreground properties (JComponent.setBackground(Color) and JComponent.setForeground(Color)) and wrapText by setWrapLine(JScrollPane, JComponent, boolean).
void	applyToDocument(StyledDocument doc, MutableAttributeSet style)	set the style of the entire-text of the document
static Color	fromJsonColor(Object o)
static Color	fromJsonColorSource(String src)
Color	getBackgroundColor()
String	getFontFamily()
int	getFontSize()
Color	getForegroundColor()
float	getLineSpacing()
float	getSpaceAbove()
StyledDocument	getTargetDocument(JComponent pane)
Style	getTargetStyle(JComponent pane)
boolean	isBackgroundCustom()
boolean	isBold()
boolean	isForegroundCustom()
boolean	isItalic()
boolean	isWrapLineNotMatch(JScrollPane pane, boolean tested)
boolean	isWrapText()
void	loadFrom(GuiPreferences prefs)
void	saveTo(GuiPreferences prefs)
void	setBackgroundColor(Color backgroundColor)
void	setBackgroundCustom(boolean backgroundCustom)
void	setBold(boolean bold)
void	setFontFamily(String fontFamily)
void	setFontSize(int fontSize)
void	setForegroundColor(Color foregroundColor)
void	setForegroundCustom(boolean foregroundCustom)
void	setFrom(JComponent pane)
void	setFrom(MutableAttributeSet style)	set propertis from the given style.
void	setItalic(boolean italic)
void	setLineSpacing(float lineSpacing)
void	setSpaceAbove(float spaceAbove)
void	setUiDefault()	overwrites properties by values from UIManagerUtil; also lineSpacing is 0.2, spaceAbove is 2.0, no background and foregorund custom, and wrapText is true.
void	setup(JComponent pane)	calls setup(MutableAttributeSet) for the document of the pane (getTargetStyle(JComponent)); and applyToDocument(StyledDocument, MutableAttributeSet) for overwritng the style to the entire text.
void	setup(MutableAttributeSet style)	set properties from the given style; only the properties the style have, and applyTo(MutableAttributeSet) to reflect the all propertis of the prefs to the target-pane
void	setWrapLine(JScrollPane parentScroll, JComponent field, boolean f)	if parentScroll is non-null and isWrapLineNotMatch(JScrollPane, boolean) with f, changes the wrapping-line by GuiSwingViewDocumentEditor.setWrapLine(JScrollPane, boolean).
void	setWrapText(boolean wrapLine)
static Object	toJsonColor(int r, int g, int b, int a)
static Object	toJsonColor(Color c)

Methods inherited from class java.lang.Object

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

Field Details

KEY_LINE_SPACING

public static final String KEY_LINE_SPACING

See Also:

• Constant Field Values

KEY_SPACE_ABOVE

public static final String KEY_SPACE_ABOVE

See Also:

• Constant Field Values

KEY_FONT_FAMILY

public static final String KEY_FONT_FAMILY

See Also:

• Constant Field Values

KEY_FONT_SIZE

public static final String KEY_FONT_SIZE

See Also:

• Constant Field Values

KEY_BOLD

public static final String KEY_BOLD

See Also:

• Constant Field Values

KEY_ITALIC

public static final String KEY_ITALIC

See Also:

• Constant Field Values

KEY_BACKGROUND_COLOR

public static final String KEY_BACKGROUND_COLOR

See Also:

• Constant Field Values

KEY_FOREGROUND_COLOR

public static final String KEY_FOREGROUND_COLOR

See Also:

• Constant Field Values

KEY_BACKGROUND_CUSTOM

public static final String KEY_BACKGROUND_CUSTOM

See Also:

• Constant Field Values

KEY_FOREGROUND_CUSTOM

public static final String KEY_FOREGROUND_CUSTOM

See Also:

• Constant Field Values

KEY_WRAP_TEXT

public static final String KEY_WRAP_TEXT

See Also:

• Constant Field Values

lineSpacing

protected float lineSpacing

spaceAbove

protected float spaceAbove

fontFamily

protected String fontFamily

fontSize

protected int fontSize

bold

protected boolean bold

italic

protected boolean italic

backgroundColor

protected Color backgroundColor

foregroundColor

protected Color foregroundColor

backgroundCustom

protected boolean backgroundCustom

foregroundCustom

protected boolean foregroundCustom

wrapText

protected boolean wrapText

DEFAULT_FONT_FAMILY

public static final String DEFAULT_FONT_FAMILY

See Also:

• Constant Field Values

DEFAULT_NUM

public static final int DEFAULT_NUM

See Also:

• Constant Field Values

defaultBackground

protected Color defaultBackground

defaultForeground

protected Color defaultForeground

allowNullValues

protected boolean allowNullValues

Constructor Details

PreferencesForDocumentSetting

public PreferencesForDocumentSetting()

initialize by null-values and black and white colors.

PreferencesForDocumentSetting

public PreferencesForDocumentSetting(JEditorPane pane)

initialize with the target pane (or if null, it sets default null values). it has 2 modes, 1. the property mode with no pane which allows null values for representing saved prefs values, 2. the practical mode with target pane which (basically) does not allow null-values, instead, it merges actual pane's value if null-values arrived.

Parameters:

pane - the target text-pane or null

Method Details

getLineSpacing

public float getLineSpacing()

getSpaceAbove

public float getSpaceAbove()

getFontFamily

public String getFontFamily()

getFontSize

public int getFontSize()

isBold

public boolean isBold()

isItalic

public boolean isItalic()

getBackgroundColor

public Color getBackgroundColor()

getForegroundColor

public Color getForegroundColor()

isBackgroundCustom

public boolean isBackgroundCustom()

isForegroundCustom

public boolean isForegroundCustom()

isWrapText

public boolean isWrapText()

setLineSpacing

public void setLineSpacing(float lineSpacing)

setSpaceAbove

public void setSpaceAbove(float spaceAbove)

setFontFamily

public void setFontFamily(String fontFamily)

setFontSize

public void setFontSize(int fontSize)

setBackgroundColor

public void setBackgroundColor(Color backgroundColor)

setForegroundColor

public void setForegroundColor(Color foregroundColor)

setBold

public void setBold(boolean bold)

setItalic

public void setItalic(boolean italic)

setBackgroundCustom

public void setBackgroundCustom(boolean backgroundCustom)

setForegroundCustom

public void setForegroundCustom(boolean foregroundCustom)

setWrapText

public void setWrapText(boolean wrapLine)

setUiDefault

public void setUiDefault()

overwrites properties by values from UIManagerUtil; also lineSpacing is 0.2, spaceAbove is 2.0, no background and foregorund custom, and wrapText is true.

toJsonColor

public static Object toJsonColor(Color c)

toJsonColor

public static Object toJsonColor(int r,
 int g,
 int b,
 int a)

fromJsonColorSource

public static Color fromJsonColorSource(String src)

fromJsonColor

public static Color fromJsonColor(Object o)

setFrom

public void setFrom(MutableAttributeSet style)

set propertis from the given style. if the style has no attribute-value, the property will be the null-value.

Parameters:

style - the source style can be Style

setFrom

public void setFrom(JComponent pane)

Parameters:

pane - the target-text-pane

See Also:

• setFrom(MutableAttributeSet)

setup

public void setup(MutableAttributeSet style)

set properties from the given style; only the properties the style have, and applyTo(MutableAttributeSet) to reflect the all propertis of the prefs to the target-pane

Parameters:

style - the source style

setup

public void setup(JComponent pane)

calls setup(MutableAttributeSet) for the document of the pane (getTargetStyle(JComponent)); and applyToDocument(StyledDocument, MutableAttributeSet) for overwritng the style to the entire text. Also update wrapText and applyToComponentWithoutDocument(JComponent)

Parameters:

pane - the target text-pane

See Also:

• setup(MutableAttributeSet)

applyTo

public void applyTo(MutableAttributeSet style)

update the target style by properties of the prefs, or if remove attributes by null-values

Parameters:

style - the modified style

applyTo

public void applyTo(JComponent pane)

set style of the target-text-pane by getTargetStyle(JComponent) and applyTo(MutableAttributeSet) ,applyToDocument(StyledDocument, MutableAttributeSet) and applyToComponentWithoutDocument(JComponent).

Parameters:

pane - the target text-pane

applyToDocument

public void applyToDocument(StyledDocument doc,
 MutableAttributeSet style)

set the style of the entire-text of the document

Parameters:

doc - the target-document or null

style - the stytle to be set

applyToComponentWithoutDocument

public void applyToComponentWithoutDocument(JComponent pane)

set the background and foreground properties (JComponent.setBackground(Color) and JComponent.setForeground(Color)) and wrapText by setWrapLine(JScrollPane, JComponent, boolean). Implementation note: it seemed to change the attributes of the default document-style. So it needs to call the method before updating the style

Parameters:

pane - the target text-pane

getTargetDocument

public StyledDocument getTargetDocument(JComponent pane)

getTargetStyle

public Style getTargetStyle(JComponent pane)

isWrapLineNotMatch

public boolean isWrapLineNotMatch(JScrollPane pane,
 boolean tested)

setWrapLine

public void setWrapLine(JScrollPane parentScroll,
 JComponent field,
 boolean f)

if parentScroll is non-null and isWrapLineNotMatch(JScrollPane, boolean) with f, changes the wrapping-line by GuiSwingViewDocumentEditor.setWrapLine(JScrollPane, boolean). Also if the field is a GuiSwingViewDocumentEditor.WrapLineSupport, call GuiSwingViewDocumentEditor.WrapLineSupport.setWrapLine(boolean)

Parameters:

parentScroll - the parent pane of the field

field - the target text-component

f - the new flag value of wrapText

loadFrom

public void loadFrom(GuiPreferences prefs)

Specified by:

loadFrom in interface GuiSwingPrefsSupports.Preferences

saveTo

public void saveTo(GuiPreferences prefs)

Specified by:

saveTo in interface GuiSwingPrefsSupports.Preferences