com.alee.laf.text
Class WebTextField

java.lang.Object
  java.awt.Component
      java.awt.Container
          javax.swing.JComponent
              javax.swing.text.JTextComponent
                  javax.swing.JTextField
                      com.alee.laf.text.WebTextField

All Implemented Interfaces:

LanguageMethods, SettingsMethods, ShapeProvider, FontMethods<WebTextField>, SizeMethods<WebTextField>, SwingMethods, java.awt.image.ImageObserver, java.awt.MenuContainer, java.io.Serializable, javax.accessibility.Accessible, javax.swing.Scrollable, javax.swing.SwingConstants

Direct Known Subclasses:

GenericCellEditor, WebAsyncTreeFilterField, WebColorChooserField, WebHotkeyField

public class WebTextField
extends javax.swing.JTextField
implements ShapeProvider, LanguageMethods, SettingsMethods, FontMethods<WebTextField>, SizeMethods<WebTextField>

User: mgarin Date: 28.06.11 Time: 1:13

See Also:

Serialized Form

Nested Class Summary

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

javax.swing.JTextField.AccessibleJTextField

Nested classes/interfaces inherited from class javax.swing.text.JTextComponent

javax.swing.text.JTextComponent.AccessibleJTextComponent, javax.swing.text.JTextComponent.DropLocation, javax.swing.text.JTextComponent.KeyBinding

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

javax.swing.JComponent.AccessibleJComponent

Nested classes/interfaces inherited from class java.awt.Container

java.awt.Container.AccessibleAWTContainer

Nested classes/interfaces inherited from class java.awt.Component

java.awt.Component.AccessibleAWTComponent, java.awt.Component.BaselineResizeBehavior, java.awt.Component.BltBufferStrategy, java.awt.Component.FlipBufferStrategy

Field Summary

Fields inherited from class javax.swing.JTextField

notifyAction

Fields inherited from class javax.swing.text.JTextComponent

DEFAULT_KEYMAP, FOCUS_ACCELERATOR_KEY

Fields inherited from class javax.swing.JComponent

accessibleContext, 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

BOTTOM_ALIGNMENT, CENTER_ALIGNMENT, LEFT_ALIGNMENT, RIGHT_ALIGNMENT, TOP_ALIGNMENT

Fields inherited from interface javax.swing.SwingConstants

BOTTOM, CENTER, EAST, HORIZONTAL, LEADING, LEFT, NEXT, NORTH, NORTH_EAST, NORTH_WEST, PREVIOUS, RIGHT, SOUTH, SOUTH_EAST, SOUTH_WEST, TOP, TRAILING, VERTICAL, WEST

Fields inherited from interface java.awt.image.ImageObserver

ABORT, ALLBITS, ERROR, FRAMEBITS, HEIGHT, PROPERTIES, SOMEBITS, WIDTH

Constructor Summary

WebTextField()

WebTextField(boolean drawBorder)

WebTextField(javax.swing.text.Document doc, java.lang.String text, int columns)

WebTextField(javax.swing.text.Document doc, java.lang.String text, int columns, boolean drawBorder)

WebTextField(int columns)

WebTextField(int columns, boolean drawBorder)

WebTextField(java.lang.String text)

WebTextField(java.lang.String text, boolean drawBorder)

WebTextField(java.lang.String text, int columns)

WebTextField(java.lang.String text, int columns, boolean drawBorder)

Method Summary

WebTextField	changeFontSize(int change) Changes font size of the specified component.
void	clear() Additional component methods
static WebTextField	createWebTextField() Styled field short creation methods
static WebTextField	createWebTextField(boolean drawBorder)
static WebTextField	createWebTextField(boolean drawBorder, int round)
static WebTextField	createWebTextField(boolean drawBorder, int round, int shadeWidth)
java.awt.Insets	getFieldMargin()
java.lang.String	getFontName() Returns component font name.
int	getFontSize() Returns component font size.
java.lang.String	getInputPrompt()
java.awt.Font	getInputPromptFont()
java.awt.Color	getInputPromptForeground()
int	getInputPromptPosition()
javax.swing.JComponent	getLeadingComponent()
int	getMinimumHeight() Returns component minimum height.
int	getMinimumWidth() Returns component minimum width.
Painter	getPainter()
int	getPreferredHeight() Returns component preferred height.
java.awt.Dimension	getPreferredSize() Returns component preferred size.
int	getPreferredWidth() Returns component preferred width.
int	getRound()
int	getShadeWidth()
javax.swing.JComponent	getTrailingComponent()
WebTextFieldUI	getWebUI()
boolean	isBoldFont() Returns whether component font is bold or not.
boolean	isDrawBackground()
boolean	isDrawBorder() UI methods
boolean	isDrawFocus()
boolean	isDrawShade()
boolean	isHideInputPromptOnFocus()
boolean	isItalicFont() Returns whether component font is italic or not.
boolean	isLanguageSet() Returns whether this component registered in LanguageManager or not.
boolean	isPlainFont() Returns whether component font is plain or not.
boolean	isWebColored()
void	loadSettings() Loads saved settings into the component if it is registered.
java.awt.Shape	provideShape() Returns component shape.
void	registerSettings(SettingsProcessor settingsProcessor) Registers component for settings auto-save.
void	registerSettings(java.lang.String key) Registers component for settings auto-save.
void	registerSettings(java.lang.String key, boolean loadInitialSettings, boolean applySettingsChanges) Registers component for settings auto-save.
<T extends DefaultValue> void	registerSettings(java.lang.String key, java.lang.Class<T> defaultValueClass) Registers component for settings auto-save.
<T extends DefaultValue> void	registerSettings(java.lang.String key, java.lang.Class<T> defaultValueClass, boolean loadInitialSettings, boolean applySettingsChanges) Registers component for settings auto-save.
void	registerSettings(java.lang.String key, java.lang.Object defaultValue) Registers component for settings auto-save.
void	registerSettings(java.lang.String key, java.lang.Object defaultValue, boolean loadInitialSettings, boolean applySettingsChanges) Registers component for settings auto-save.
void	registerSettings(java.lang.String group, java.lang.String key) Registers component for settings auto-save.
<T extends DefaultValue> void	registerSettings(java.lang.String group, java.lang.String key, java.lang.Class<T> defaultValueClass) Registers component for settings auto-save.
<T extends DefaultValue> void	registerSettings(java.lang.String group, java.lang.String key, java.lang.Class<T> defaultValueClass, boolean loadInitialSettings, boolean applySettingsChanges) Registers component for settings auto-save.
void	registerSettings(java.lang.String group, java.lang.String key, java.lang.Object defaultValue) Registers component for settings auto-save.
void	registerSettings(java.lang.String group, java.lang.String key, java.lang.Object defaultValue, boolean loadInitialSettings, boolean applySettingsChanges) Registers component for settings auto-save.
void	removeLanguage() Unregisters component from LanguageManager.
void	removeLanguageUpdater() Unregisters any custom language updater set for this component.
void	saveSettings() Saves component settings.
WebTextField	setBoldFont() Sets bold font for the component.
WebTextField	setBoldFont(boolean apply) Sets bold font for the component.
void	setDrawBackground(boolean drawBackground)
void	setDrawBorder(boolean drawBorder)
void	setDrawFocus(boolean drawFocus)
void	setDrawShade(boolean drawShade)
void	setFieldMargin(java.awt.Insets margin)
void	setFieldMargin(int spacing)
void	setFieldMargin(int top, int left, int bottom, int right)
WebTextField	setFontName(java.lang.String fontName) Sets component font name.
WebTextField	setFontSize(int fontSize) Sets component font size.
WebTextField	setFontSizeAndStyle(int fontSize, boolean bold, boolean italic) Sets font size and style for the specified component.
WebTextField	setFontSizeAndStyle(int fontSize, int style) Sets font size and style for the specified component.
WebTextField	setFontStyle(boolean bold, boolean italic) Sets component font style.
WebTextField	setFontStyle(int style) Sets component font style.
void	setHideInputPromptOnFocus(boolean hideInputPromptOnFocus)
void	setInputPrompt(java.lang.String inputPrompt)
void	setInputPromptFont(java.awt.Font inputPromptFont)
void	setInputPromptForeground(java.awt.Color inputPromptForeground)
void	setInputPromptPosition(int inputPromptPosition)
WebTextField	setItalicFont() Sets italic or plain font for the component.
WebTextField	setItalicFont(boolean apply) Sets italic or plain font for the component.
void	setLanguage(java.lang.String key, java.lang.Object... data) Registers component in LanguageManager under specified key and with specified formatting data.
void	setLanguageUpdater(LanguageUpdater updater) Registers custom language updater for this component.
void	setLeadingComponent(javax.swing.JComponent leadingComponent)
void	setMargin(int spacing)
void	setMargin(int top, int left, int bottom, int right)
WebTextField	setMinimumHeight(int minimumHeight) Sets component minimum height.
WebTextField	setMinimumWidth(int minimumWidth) Sets component minimum width.
void	setPainter(Painter painter)
WebTextField	setPlainFont() Sets plain font for the component.
WebTextField	setPlainFont(boolean apply) Sets plain font for the component.
WebTextField	setPreferredHeight(int preferredHeight) Sets component preferred height.
WebTextField	setPreferredWidth(int preferredWidth) Sets component preferred width.
void	setRound(int round)
void	setShadeWidth(int shadeWidth)
void	setTrailingComponent(javax.swing.JComponent trailingComponent)
void	setWebColored(boolean webColored)
void	unregisterSettings() Unregisters component from settings auto-save.
void	updateLanguage(java.lang.Object... data) Updates component language and formatting data.
void	updateLanguage(java.lang.String key, java.lang.Object... data) Changes component language key and updates its language and formatting data.
void	updateUI()

Methods inherited from class javax.swing.JTextField

actionPropertyChanged, addActionListener, configurePropertiesFromAction, createActionPropertyChangeListener, createDefaultModel, fireActionPerformed, getAccessibleContext, getAction, getActionListeners, getActions, getColumns, getColumnWidth, getHorizontalAlignment, getHorizontalVisibility, getScrollOffset, getUIClassID, isValidateRoot, paramString, postActionEvent, removeActionListener, scrollRectToVisible, setAction, setActionCommand, setColumns, setDocument, setFont, setHorizontalAlignment, setScrollOffset

Methods inherited from class javax.swing.text.JTextComponent

addCaretListener, addInputMethodListener, addKeymap, copy, cut, fireCaretUpdate, getCaret, getCaretColor, getCaretListeners, getCaretPosition, getDisabledTextColor, getDocument, getDragEnabled, getDropLocation, getDropMode, getFocusAccelerator, getHighlighter, getInputMethodRequests, getKeymap, getKeymap, getMargin, getNavigationFilter, getPreferredScrollableViewportSize, getPrintable, getScrollableBlockIncrement, getScrollableTracksViewportHeight, getScrollableTracksViewportWidth, getScrollableUnitIncrement, getSelectedText, getSelectedTextColor, getSelectionColor, getSelectionEnd, getSelectionStart, getText, getText, getToolTipText, getUI, isEditable, loadKeymap, modelToView, moveCaretPosition, paste, print, print, print, processInputMethodEvent, read, removeCaretListener, removeKeymap, removeNotify, replaceSelection, select, selectAll, setCaret, setCaretColor, setCaretPosition, setComponentOrientation, setDisabledTextColor, setDragEnabled, setDropMode, setEditable, setFocusAccelerator, setHighlighter, setKeymap, setMargin, setNavigationFilter, setSelectedTextColor, setSelectionColor, setSelectionEnd, setSelectionStart, setText, setUI, viewToModel, write

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, getRegisteredKeyStrokes, getRootPane, getSize, getToolTipLocation, getToolTipText, getTopLevelAncestor, getTransferHandler, getVerifyInputWhenFocusTarget, getVetoableChangeListeners, getVisibleRect, getWidth, getX, getY, grabFocus, isDoubleBuffered, isLightweightComponent, isManagingFocus, isOpaque, isOptimizedDrawingEnabled, isPaintingForPrint, isPaintingTile, isRequestFocusEnabled, paint, paintBorder, paintChildren, paintComponent, paintImmediately, paintImmediately, print, printAll, printBorder, printChildren, printComponent, processComponentKeyEvent, processKeyBinding, processKeyEvent, processMouseEvent, processMouseMotionEvent, putClientProperty, registerKeyboardAction, registerKeyboardAction, removeAncestorListener, removeVetoableChangeListener, repaint, repaint, requestDefaultFocus, requestFocus, requestFocus, requestFocusInWindow, requestFocusInWindow, resetKeyboardActions, reshape, revalidate, setActionMap, setAlignmentX, setAlignmentY, setAutoscrolls, setBackground, setBorder, setComponentPopupMenu, setDebugGraphicsOptions, setDefaultLocale, setDoubleBuffered, setEnabled, setFocusTraversalKeys, 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, transferFocusBackward, transferFocusDownCycle, validate, validateTree

Methods inherited from class java.awt.Component

action, add, addComponentListener, addFocusListener, addHierarchyBoundsListener, addHierarchyListener, 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, getKeyListeners, getLocale, getLocation, getLocationOnScreen, getMouseListeners, getMouseMotionListeners, getMousePosition, getMouseWheelListeners, getName, getParent, getPeer, getPropertyChangeListeners, getPropertyChangeListeners, getSize, getToolkit, getTreeLock, gotFocus, handleEvent, hasFocus, hide, 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, processMouseWheelEvent, remove, removeComponentListener, removeFocusListener, removeHierarchyBoundsListener, removeHierarchyListener, removeInputMethodListener, removeKeyListener, removeMouseListener, removeMouseMotionListener, removeMouseWheelListener, removePropertyChangeListener, removePropertyChangeListener, repaint, repaint, repaint, resize, resize, setBounds, setBounds, setCursor, setDropTarget, setFocusable, setFocusTraversalKeysEnabled, setIgnoreRepaint, setLocale, setLocation, setLocation, setName, setSize, setSize, show, show, size, toString, transferFocus, transferFocusUpCycle

Methods inherited from class java.lang.Object

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

Constructor Detail

WebTextField

public WebTextField()

WebTextField

public WebTextField(boolean drawBorder)

WebTextField

public WebTextField(java.lang.String text)

WebTextField

public WebTextField(java.lang.String text,
                    boolean drawBorder)

WebTextField

public WebTextField(int columns)

WebTextField

public WebTextField(int columns,
                    boolean drawBorder)

WebTextField

public WebTextField(java.lang.String text,
                    int columns)

WebTextField

public WebTextField(java.lang.String text,
                    int columns,
                    boolean drawBorder)

WebTextField

public WebTextField(javax.swing.text.Document doc,
                    java.lang.String text,
                    int columns)

WebTextField

public WebTextField(javax.swing.text.Document doc,
                    java.lang.String text,
                    int columns,
                    boolean drawBorder)

Method Detail

clear

public void clear()

Additional component methods

isDrawBorder

public boolean isDrawBorder()

UI methods

setDrawBorder

public void setDrawBorder(boolean drawBorder)

isDrawFocus

public boolean isDrawFocus()

setDrawFocus

public void setDrawFocus(boolean drawFocus)

getLeadingComponent

public javax.swing.JComponent getLeadingComponent()

setLeadingComponent

public void setLeadingComponent(javax.swing.JComponent leadingComponent)

getTrailingComponent

public javax.swing.JComponent getTrailingComponent()

setTrailingComponent

public void setTrailingComponent(javax.swing.JComponent trailingComponent)

setMargin

public void setMargin(int top,
                      int left,
                      int bottom,
                      int right)

setMargin

public void setMargin(int spacing)

setFieldMargin

public void setFieldMargin(java.awt.Insets margin)

setFieldMargin

public void setFieldMargin(int top,
                           int left,
                           int bottom,
                           int right)

setFieldMargin

public void setFieldMargin(int spacing)

getFieldMargin

public java.awt.Insets getFieldMargin()

getRound

public int getRound()

setRound

public void setRound(int round)

isDrawShade

public boolean isDrawShade()

setDrawShade

public void setDrawShade(boolean drawShade)

getShadeWidth

public int getShadeWidth()

setShadeWidth

public void setShadeWidth(int shadeWidth)

isDrawBackground

public boolean isDrawBackground()

setDrawBackground

public void setDrawBackground(boolean drawBackground)

isWebColored

public boolean isWebColored()

setWebColored

public void setWebColored(boolean webColored)

getPainter

public Painter getPainter()

setPainter

public void setPainter(Painter painter)

getInputPrompt

public java.lang.String getInputPrompt()

setInputPrompt

public void setInputPrompt(java.lang.String inputPrompt)

getInputPromptFont

public java.awt.Font getInputPromptFont()

setInputPromptFont

public void setInputPromptFont(java.awt.Font inputPromptFont)

getInputPromptForeground

public java.awt.Color getInputPromptForeground()

setInputPromptForeground

public void setInputPromptForeground(java.awt.Color inputPromptForeground)

getInputPromptPosition

public int getInputPromptPosition()

setInputPromptPosition

public void setInputPromptPosition(int inputPromptPosition)

isHideInputPromptOnFocus

public boolean isHideInputPromptOnFocus()

setHideInputPromptOnFocus

public void setHideInputPromptOnFocus(boolean hideInputPromptOnFocus)

provideShape

public java.awt.Shape provideShape()

Description copied from interface: ShapeProvider

Returns component shape.

Specified by:

provideShape in interface ShapeProvider

Returns:

component shape

getWebUI

public WebTextFieldUI getWebUI()

updateUI

public void updateUI()

Overrides:

updateUI in class javax.swing.text.JTextComponent

setLanguage

public void setLanguage(java.lang.String key,
                        java.lang.Object... data)

Registers component in LanguageManager under specified key and with specified formatting data.

Specified by:

setLanguage in interface LanguageMethods

Parameters:

key - language record key

data - formatting data

updateLanguage

public void updateLanguage(java.lang.Object... data)

Updates component language and formatting data.

Specified by:

updateLanguage in interface LanguageMethods

Parameters:

data - new formatting data

updateLanguage

public void updateLanguage(java.lang.String key,
                           java.lang.Object... data)

Changes component language key and updates its language and formatting data.

Specified by:

updateLanguage in interface LanguageMethods

Parameters:

key - new language key

data - new formatting data

removeLanguage

public void removeLanguage()

Unregisters component from LanguageManager.

Specified by:

removeLanguage in interface LanguageMethods

isLanguageSet

public boolean isLanguageSet()

Returns whether this component registered in LanguageManager or not.

Specified by:

isLanguageSet in interface LanguageMethods

Returns:

true if component is registered in LanguageManager, false otherwise

setLanguageUpdater

public void setLanguageUpdater(LanguageUpdater updater)

Registers custom language updater for this component.

Specified by:

setLanguageUpdater in interface LanguageMethods

Parameters:

updater - component language updater

removeLanguageUpdater

public void removeLanguageUpdater()

Unregisters any custom language updater set for this component.

Specified by:

removeLanguageUpdater in interface LanguageMethods

registerSettings

public void registerSettings(java.lang.String key)

Registers component for settings auto-save.

Also registered component will be: - listened for settings changes to save them when requested - automatically updated with any loaded settings for that key if requested - automatically updated with any changes made in its settings if requested

Specified by:

registerSettings in interface SettingsMethods

Parameters:

key - component settings key

registerSettings

public <T extends DefaultValue> void registerSettings(java.lang.String key,
                                                      java.lang.Class<T> defaultValueClass)

Registers component for settings auto-save.

Also registered component will be: - listened for settings changes to save them when requested - automatically updated with any loaded settings for that key if requested - automatically updated with any changes made in its settings if requested

Specified by:

registerSettings in interface SettingsMethods

Type Parameters:

T - default value type

Parameters:

key - component settings key

defaultValueClass - component default value class

See Also:

DefaultValue

registerSettings

public void registerSettings(java.lang.String key,
                             java.lang.Object defaultValue)

Registers component for settings auto-save.

Also registered component will be: - listened for settings changes to save them when requested - automatically updated with any loaded settings for that key if requested - automatically updated with any changes made in its settings if requested

Specified by:

registerSettings in interface SettingsMethods

Parameters:

key - component settings key

defaultValue - component default value

registerSettings

public void registerSettings(java.lang.String group,
                             java.lang.String key)

Registers component for settings auto-save.

Also registered component will be: - listened for settings changes to save them when requested - automatically updated with any loaded settings for that key if requested - automatically updated with any changes made in its settings if requested

Specified by:

registerSettings in interface SettingsMethods

Parameters:

group - component settings group

key - component settings key

registerSettings

public <T extends DefaultValue> void registerSettings(java.lang.String group,
                                                      java.lang.String key,
                                                      java.lang.Class<T> defaultValueClass)

Registers component for settings auto-save.

Also registered component will be: - listened for settings changes to save them when requested - automatically updated with any loaded settings for that key if requested - automatically updated with any changes made in its settings if requested

Specified by:

registerSettings in interface SettingsMethods

Type Parameters:

T - default value type

Parameters:

group - component settings group

key - component settings key

defaultValueClass - component default value class

See Also:

DefaultValue

registerSettings

public void registerSettings(java.lang.String group,
                             java.lang.String key,
                             java.lang.Object defaultValue)

Registers component for settings auto-save.

Also registered component will be: - listened for settings changes to save them when requested - automatically updated with any loaded settings for that key if requested - automatically updated with any changes made in its settings if requested

Specified by:

registerSettings in interface SettingsMethods

Parameters:

group - component settings group

key - component settings key

defaultValue - component default value

registerSettings

public void registerSettings(java.lang.String key,
                             boolean loadInitialSettings,
                             boolean applySettingsChanges)

Registers component for settings auto-save.

Also registered component will be: - listened for settings changes to save them when requested - automatically updated with any loaded settings for that key if requested - automatically updated with any changes made in its settings if requested

Specified by:

registerSettings in interface SettingsMethods

Parameters:

key - component settings key

loadInitialSettings - whether to load initial available settings into the component or not

applySettingsChanges - whether to apply settings changes to the component or not

registerSettings

public <T extends DefaultValue> void registerSettings(java.lang.String key,
                                                      java.lang.Class<T> defaultValueClass,
                                                      boolean loadInitialSettings,
                                                      boolean applySettingsChanges)

Registers component for settings auto-save.

Also registered component will be: - listened for settings changes to save them when requested - automatically updated with any loaded settings for that key if requested - automatically updated with any changes made in its settings if requested

Specified by:

registerSettings in interface SettingsMethods

Type Parameters:

T - default value type

Parameters:

key - component settings key

defaultValueClass - component default value class

loadInitialSettings - whether to load initial available settings into the component or not

applySettingsChanges - whether to apply settings changes to the component or not

See Also:

DefaultValue

registerSettings

public void registerSettings(java.lang.String key,
                             java.lang.Object defaultValue,
                             boolean loadInitialSettings,
                             boolean applySettingsChanges)

Registers component for settings auto-save.

Also registered component will be: - listened for settings changes to save them when requested - automatically updated with any loaded settings for that key if requested - automatically updated with any changes made in its settings if requested

Specified by:

registerSettings in interface SettingsMethods

Parameters:

key - component settings key

defaultValue - component default value

loadInitialSettings - whether to load initial available settings into the component or not

applySettingsChanges - whether to apply settings changes to the component or not

registerSettings

public <T extends DefaultValue> void registerSettings(java.lang.String group,
                                                      java.lang.String key,
                                                      java.lang.Class<T> defaultValueClass,
                                                      boolean loadInitialSettings,
                                                      boolean applySettingsChanges)

Registers component for settings auto-save.

Also registered component will be: - listened for settings changes to save them when requested - automatically updated with any loaded settings for that key if requested - automatically updated with any changes made in its settings if requested

Specified by:

registerSettings in interface SettingsMethods

Type Parameters:

T - default value type

Parameters:

group - component settings group

key - component settings key

defaultValueClass - component default value class

loadInitialSettings - whether to load initial available settings into the component or not

applySettingsChanges - whether to apply settings changes to the component or not

See Also:

DefaultValue

registerSettings

public void registerSettings(java.lang.String group,
                             java.lang.String key,
                             java.lang.Object defaultValue,
                             boolean loadInitialSettings,
                             boolean applySettingsChanges)

Registers component for settings auto-save.

Also registered component will be: - listened for settings changes to save them when requested - automatically updated with any loaded settings for that key if requested - automatically updated with any changes made in its settings if requested

Specified by:

registerSettings in interface SettingsMethods

Parameters:

group - component settings group

key - component settings key

defaultValue - component default value

loadInitialSettings - whether to load initial available settings into the component or not

applySettingsChanges - whether to apply settings changes to the component or not

registerSettings

public void registerSettings(SettingsProcessor settingsProcessor)

Registers component for settings auto-save.

Also registered component will be: - listened for settings changes to save them when requested - automatically updated with any loaded settings for that key if requested - automatically updated with any changes made in its settings if requested

Specified by:

registerSettings in interface SettingsMethods

Parameters:

settingsProcessor - component settings processor

unregisterSettings

public void unregisterSettings()

Unregisters component from settings auto-save.

Specified by:

unregisterSettings in interface SettingsMethods

loadSettings

public void loadSettings()

Loads saved settings into the component if it is registered.

Specified by:

loadSettings in interface SettingsMethods

saveSettings

public void saveSettings()

Saves component settings.

Specified by:

saveSettings in interface SettingsMethods

setPlainFont

public WebTextField setPlainFont()

Sets plain font for the component.

Specified by:

setPlainFont in interface FontMethods<WebTextField>

Returns:

modified component

setPlainFont

public WebTextField setPlainFont(boolean apply)

Sets plain font for the component.

Specified by:

setPlainFont in interface FontMethods<WebTextField>

Parameters:

apply - whether to apply font changes or not

Returns:

modified component

isPlainFont

public boolean isPlainFont()

Returns whether component font is plain or not.

Specified by:

isPlainFont in interface FontMethods<WebTextField>

Returns:

true if component font is plain, false otherwise

setBoldFont

public WebTextField setBoldFont()

Sets bold font for the component.

Specified by:

setBoldFont in interface FontMethods<WebTextField>

Returns:

modified component

setBoldFont

public WebTextField setBoldFont(boolean apply)

Sets bold font for the component.

Specified by:

setBoldFont in interface FontMethods<WebTextField>

Parameters:

apply - whether to apply font changes or not

Returns:

modified component

isBoldFont

public boolean isBoldFont()

Returns whether component font is bold or not.

Specified by:

isBoldFont in interface FontMethods<WebTextField>

Returns:

true if component font is bold, false otherwise

setItalicFont

public WebTextField setItalicFont()

Sets italic or plain font for the component.

Specified by:

setItalicFont in interface FontMethods<WebTextField>

Returns:

modified component

setItalicFont

public WebTextField setItalicFont(boolean apply)

Sets italic or plain font for the component.

Specified by:

setItalicFont in interface FontMethods<WebTextField>

Parameters:

apply - whether to apply font changes or not

Returns:

modified component

isItalicFont

public boolean isItalicFont()

Returns whether component font is italic or not.

Specified by:

isItalicFont in interface FontMethods<WebTextField>

Returns:

true if component font is italic, false otherwise

setFontStyle

public WebTextField setFontStyle(boolean bold,
                                 boolean italic)

Sets component font style.

Specified by:

setFontStyle in interface FontMethods<WebTextField>

Parameters:

bold - whether should set bold font or not

italic - whether should set italic font or not

Returns:

modified component

setFontStyle

public WebTextField setFontStyle(int style)

Sets component font style.

Specified by:

setFontStyle in interface FontMethods<WebTextField>

Parameters:

style - new style

Returns:

modified component

setFontSize

public WebTextField setFontSize(int fontSize)

Sets component font size.

Specified by:

setFontSize in interface FontMethods<WebTextField>

Parameters:

fontSize - font size

Returns:

modified component

changeFontSize

public WebTextField changeFontSize(int change)

Changes font size of the specified component.

Specified by:

changeFontSize in interface FontMethods<WebTextField>

Parameters:

change - font size change amount

Returns:

modified component

getFontSize

public int getFontSize()

Returns component font size.

Specified by:

getFontSize in interface FontMethods<WebTextField>

Returns:

component font size

setFontSizeAndStyle

public WebTextField setFontSizeAndStyle(int fontSize,
                                        boolean bold,
                                        boolean italic)

Sets font size and style for the specified component.

Specified by:

setFontSizeAndStyle in interface FontMethods<WebTextField>

Parameters:

fontSize - new font size

bold - whether should set bold font or not

italic - whether should set italic font or not

Returns:

modified component

setFontSizeAndStyle

public WebTextField setFontSizeAndStyle(int fontSize,
                                        int style)

Sets font size and style for the specified component.

Specified by:

setFontSizeAndStyle in interface FontMethods<WebTextField>

Parameters:

fontSize - new font size

style - new style

Returns:

modified component

setFontName

public WebTextField setFontName(java.lang.String fontName)

Sets component font name.

Specified by:

setFontName in interface FontMethods<WebTextField>

Parameters:

fontName - new font name

Returns:

modified component

getFontName

public java.lang.String getFontName()

Returns component font name.

Specified by:

getFontName in interface FontMethods<WebTextField>

Returns:

component font name

createWebTextField

public static WebTextField createWebTextField()

Styled field short creation methods

createWebTextField

public static WebTextField createWebTextField(boolean drawBorder)

createWebTextField

public static WebTextField createWebTextField(boolean drawBorder,
                                              int round)

createWebTextField

public static WebTextField createWebTextField(boolean drawBorder,
                                              int round,
                                              int shadeWidth)

getPreferredWidth

public int getPreferredWidth()

Returns component preferred width.

Specified by:

getPreferredWidth in interface SizeMethods<WebTextField>

Returns:

component preferred width

setPreferredWidth

public WebTextField setPreferredWidth(int preferredWidth)

Sets component preferred width. Pass -1 to let component choose preferred width on its own.

Specified by:

setPreferredWidth in interface SizeMethods<WebTextField>

Parameters:

preferredWidth - new component preferred width

Returns:

modified component

getPreferredHeight

public int getPreferredHeight()

Returns component preferred height.

Specified by:

getPreferredHeight in interface SizeMethods<WebTextField>

Returns:

component preferred height

setPreferredHeight

public WebTextField setPreferredHeight(int preferredHeight)

Sets component preferred height. Pass -1 to let component choose preferred height on its own.

Specified by:

setPreferredHeight in interface SizeMethods<WebTextField>

Parameters:

preferredHeight - new component preferred height

Returns:

modified component

getMinimumWidth

public int getMinimumWidth()

Returns component minimum width.

Specified by:

getMinimumWidth in interface SizeMethods<WebTextField>

Returns:

component minimum width

setMinimumWidth

public WebTextField setMinimumWidth(int minimumWidth)

Sets component minimum width. Pass -1 to let component choose minimum width on its own.

Specified by:

setMinimumWidth in interface SizeMethods<WebTextField>

Parameters:

minimumWidth - new component minimum width

Returns:

modified component

getMinimumHeight

public int getMinimumHeight()

Returns component minimum height.

Specified by:

getMinimumHeight in interface SizeMethods<WebTextField>

Returns:

component minimum height

setMinimumHeight

public WebTextField setMinimumHeight(int minimumHeight)

Sets component minimum height. Pass -1 to let component choose minimum height on its own.

Specified by:

setMinimumHeight in interface SizeMethods<WebTextField>

Parameters:

minimumHeight - new component minimum height

Returns:

modified component

getPreferredSize

public java.awt.Dimension getPreferredSize()

Returns component preferred size.

Specified by:

getPreferredSize in interface SizeMethods<WebTextField>

Overrides:

getPreferredSize in class javax.swing.JTextField

Returns:

component preferred size