com.alee.laf.text

Class WebTextPane

java.lang.Object

java.awt.Component

java.awt.Container

javax.swing.JComponent

javax.swing.text.JTextComponent

javax.swing.JEditorPane

javax.swing.JTextPane

com.alee.laf.text.WebTextPane

All Implemented Interfaces:

com.alee.managers.language.LanguageMethods, com.alee.managers.settings.SettingsMethods, MarginSupport, PaddingSupport, ShapeProvider, Skinnable, Styleable, Paintable, DocumentEventMethods, EventMethods, FontMethods<WebTextPane>, SizeMethods<WebTextPane>, com.alee.utils.swing.SwingMethods, java.awt.image.ImageObserver, java.awt.MenuContainer, java.io.Serializable, javax.accessibility.Accessible, javax.swing.Scrollable

public class WebTextPane
extends javax.swing.JTextPane
implements Styleable, Skinnable, Paintable, ShapeProvider, MarginSupport, PaddingSupport, DocumentEventMethods, EventMethods, com.alee.managers.language.LanguageMethods, com.alee.managers.settings.SettingsMethods, FontMethods<WebTextPane>, SizeMethods<WebTextPane>

See Also:

Serialized Form

Nested Class Summary

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

javax.swing.JEditorPane.AccessibleJEditorPane, javax.swing.JEditorPane.AccessibleJEditorPaneHTML, javax.swing.JEditorPane.JEditorPaneAccessibleHypertextSupport

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.JEditorPane

HONOR_DISPLAY_PROPERTIES, W3C_LENGTH_UNITS

Fields inherited from class javax.swing.text.JTextComponent

DEFAULT_KEYMAP, FOCUS_ACCELERATOR_KEY

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 com.alee.managers.style.MarginSupport

EMPTY

Fields inherited from interface com.alee.managers.style.PaddingSupport

EMPTY

Fields inherited from interface com.alee.utils.swing.SizeMethods

UNDEFINED

Fields inherited from interface java.awt.image.ImageObserver

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

Constructor Summary

Constructors

Constructor and Description
WebTextPane()
WebTextPane(javax.swing.text.StyledDocument doc)
WebTextPane(StyleId id)
WebTextPane(StyleId id, javax.swing.text.StyledDocument doc)

Method Summary

Modifier and Type	Method and Description
void	addStyleListener(StyleListener listener) Adds style change listener.
WebTextPane	changeFontSize(int change) Changes font size of the specified component.
void	clear() Clears editor text.
Painter	getCustomPainter() Returns custom base painter for this component.
Painter	getCustomPainter(java.lang.String id) Returns custom painter for this component.
java.util.Map<java.lang.String,Painter>	getCustomPainters() Returns all custom painters for this component.
java.lang.String	getFontName() Returns component font name.
int	getFontSize() Returns component font size.
java.lang.String	getInputPrompt() Returns input prompt text.
java.awt.Insets	getMargin() Returns current margin.
int	getMaximumHeight() Returns component maximum height.
int	getMaximumWidth() Returns component maximum width.
int	getMinimumHeight() Returns component minimum height.
int	getMinimumWidth() Returns component minimum width.
java.awt.Insets	getPadding() Returns current padding.
int	getPreferredHeight() Returns component preferred height.
java.awt.Dimension	getPreferredSize() Returns component preferred size.
int	getPreferredWidth() Returns component preferred width.
Skin	getSkin() Returns skin currently applied to this component.
StyleId	getStyleId() Returns component style ID.
boolean	isBoldFont() Returns whether component font is bold or not.
boolean	isItalicFont() Returns whether component font is italic or not.
boolean	isLanguageSet()
boolean	isPlainFont() Returns whether component font is plain or not.
void	loadSettings()
com.alee.utils.general.Pair<DocumentChangeListener,java.beans.PropertyChangeListener>	onChange(DocumentEventRunnable runnable) Shortcut method for document change event.
java.awt.event.MouseAdapter	onDoubleClick(MouseEventRunnable runnable) Shortcut method for double-click mouse event.
java.awt.event.FocusAdapter	onFocusGain(FocusEventRunnable runnable) Shortcut method for focus gain event.
java.awt.event.FocusAdapter	onFocusLoss(FocusEventRunnable runnable) Shortcut method for focus loss event.
java.awt.event.KeyAdapter	onKeyPress(HotkeyData hotkey, KeyEventRunnable runnable) Shortcut method for key press event.
java.awt.event.KeyAdapter	onKeyPress(KeyEventRunnable runnable) Shortcut method for key press event.
java.awt.event.KeyAdapter	onKeyRelease(HotkeyData hotkey, KeyEventRunnable runnable) Shortcut method for key release event.
java.awt.event.KeyAdapter	onKeyRelease(KeyEventRunnable runnable) Shortcut method for key release event.
java.awt.event.KeyAdapter	onKeyType(HotkeyData hotkey, KeyEventRunnable runnable) Shortcut method for key type event.
java.awt.event.KeyAdapter	onKeyType(KeyEventRunnable runnable) Shortcut method for key type event.
java.awt.event.MouseAdapter	onMenuTrigger(MouseEventRunnable runnable) Shortcut method for mouse event triggering popup menu.
java.awt.event.MouseAdapter	onMouseClick(MouseButton mouseButton, MouseEventRunnable runnable) Shortcut method for mouse click event.
java.awt.event.MouseAdapter	onMouseClick(MouseEventRunnable runnable) Shortcut method for mouse click event.
java.awt.event.MouseAdapter	onMouseDrag(MouseButton mouseButton, MouseEventRunnable runnable) Shortcut method for mouse drag event.
java.awt.event.MouseAdapter	onMouseDrag(MouseEventRunnable runnable) Shortcut method for mouse drag event.
java.awt.event.MouseAdapter	onMouseEnter(MouseEventRunnable runnable) Shortcut method for mouse enter event.
java.awt.event.MouseAdapter	onMouseExit(MouseEventRunnable runnable) Shortcut method for mouse exit event.
java.awt.event.MouseAdapter	onMousePress(MouseButton mouseButton, MouseEventRunnable runnable) Shortcut method for mouse press event.
java.awt.event.MouseAdapter	onMousePress(MouseEventRunnable runnable) Shortcut method for mouse press event.
java.awt.Shape	provideShape() Returns component shape.
void	registerSettings(com.alee.managers.settings.SettingsProcessor settingsProcessor)
void	registerSettings(java.lang.String key) Settings methods
void	registerSettings(java.lang.String key, boolean loadInitialSettings, boolean applySettingsChanges)
<T extends com.alee.managers.settings.DefaultValue> void	registerSettings(java.lang.String key, java.lang.Class<T> defaultValueClass)
<T extends com.alee.managers.settings.DefaultValue> void	registerSettings(java.lang.String key, java.lang.Class<T> defaultValueClass, boolean loadInitialSettings, boolean applySettingsChanges)
void	registerSettings(java.lang.String key, java.lang.Object defaultValue)
void	registerSettings(java.lang.String key, java.lang.Object defaultValue, boolean loadInitialSettings, boolean applySettingsChanges)
void	registerSettings(java.lang.String group, java.lang.String key)
<T extends com.alee.managers.settings.DefaultValue> void	registerSettings(java.lang.String group, java.lang.String key, java.lang.Class<T> defaultValueClass)
<T extends com.alee.managers.settings.DefaultValue> void	registerSettings(java.lang.String group, java.lang.String key, java.lang.Class<T> defaultValueClass, boolean loadInitialSettings, boolean applySettingsChanges)
void	registerSettings(java.lang.String group, java.lang.String key, java.lang.Object defaultValue)
void	registerSettings(java.lang.String group, java.lang.String key, java.lang.Object defaultValue, boolean loadInitialSettings, boolean applySettingsChanges)
void	removeLanguage()
void	removeLanguageUpdater()
void	removeStyleListener(StyleListener listener) Removes style change listener.
boolean	restoreDefaultPainters() Restores default painters for this component.
Skin	restoreSkin() Restores global skin for this component and all of its children linked via StyleId.
void	saveSettings()
WebTextPane	setBoldFont() Sets bold font for the component.
WebTextPane	setBoldFont(boolean apply) Sets bold font for the component.
Painter	setCustomPainter(Painter painter) Sets custom base painter for this component.
Painter	setCustomPainter(java.lang.String id, Painter painter) Sets custom painter for this component under the specified painter ID.
WebTextPane	setFontName(java.lang.String fontName) Sets component font name.
WebTextPane	setFontSize(int fontSize) Sets component font size.
WebTextPane	setFontSizeAndStyle(int fontSize, boolean bold, boolean italic) Sets font size and style for the specified component.
WebTextPane	setFontSizeAndStyle(int fontSize, int style) Sets font size and style for the specified component.
WebTextPane	setFontStyle(boolean bold, boolean italic) Sets component font style.
WebTextPane	setFontStyle(int style) Sets component font style.
void	setInputPrompt(java.lang.String text) Sets input prompt text.
WebTextPane	setItalicFont() Sets italic or plain font for the component.
WebTextPane	setItalicFont(boolean apply) Sets italic or plain font for the component.
void	setLanguage(java.lang.String key, java.lang.Object... data) Language methods
void	setLanguageUpdater(com.alee.managers.language.updaters.LanguageUpdater updater)
void	setMargin(java.awt.Insets margin) Sets new margin.
void	setMargin(int margin) Sets new margin.
void	setMargin(int top, int left, int bottom, int right) Sets new margin.
WebTextPane	setMaximumHeight(int maximumHeight) Sets component maximum height.
WebTextPane	setMaximumWidth(int maximumWidth) Sets component maximum width.
WebTextPane	setMinimumHeight(int minimumHeight) Sets component minimum height.
WebTextPane	setMinimumWidth(int minimumWidth) Sets component minimum width.
void	setPadding(java.awt.Insets padding) Sets new padding.
void	setPadding(int padding) Sets new padding.
void	setPadding(int top, int left, int bottom, int right) Sets new padding.
WebTextPane	setPlainFont() Font methods
WebTextPane	setPlainFont(boolean apply) Sets plain font for the component.
WebTextPane	setPreferredHeight(int preferredHeight) Sets component preferred height.
WebTextPane	setPreferredSize(int width, int height) Sets component preferred size.
WebTextPane	setPreferredWidth(int preferredWidth) Sets component preferred width.
Skin	setSkin(Skin skin) Applies specified skin to the specified component and all of its children linked via StyleId.
Skin	setSkin(Skin skin, boolean recursively) Applies specified skin to the specified component and all of its children linked via StyleId.
StyleId	setStyleId(StyleId id) Sets new component style ID.
void	unregisterSettings()
void	updateLanguage(java.lang.Object... data)
void	updateLanguage(java.lang.String key, java.lang.Object... data)
void	updateUI() Installs a Web-UI into this component.

Methods inherited from class javax.swing.JTextPane

addStyle, createDefaultEditorKit, getCharacterAttributes, getInputAttributes, getLogicalStyle, getParagraphAttributes, getStyle, getStyledDocument, getStyledEditorKit, getUIClassID, insertComponent, insertIcon, paramString, removeStyle, replaceSelection, setCharacterAttributes, setDocument, setEditorKit, setLogicalStyle, setParagraphAttributes, setStyledDocument

Methods inherited from class javax.swing.JEditorPane

addHyperlinkListener, createEditorKitForContentType, fireHyperlinkUpdate, getAccessibleContext, getContentType, getEditorKit, getEditorKitClassNameForContentType, getEditorKitForContentType, getHyperlinkListeners, getPage, getScrollableTracksViewportHeight, getScrollableTracksViewportWidth, getStream, getText, read, registerEditorKitForContentType, registerEditorKitForContentType, removeHyperlinkListener, scrollToReference, setContentType, setEditorKitForContentType, setPage, setPage, setText

Methods inherited from class javax.swing.text.JTextComponent

addCaretListener, addInputMethodListener, addKeymap, copy, cut, fireCaretUpdate, getActions, getCaret, getCaretColor, getCaretListeners, getCaretPosition, getDisabledTextColor, getDocument, getDragEnabled, getDropLocation, getDropMode, getFocusAccelerator, getHighlighter, getInputMethodRequests, getKeymap, getKeymap, getNavigationFilter, getPreferredScrollableViewportSize, getPrintable, getScrollableBlockIncrement, getScrollableUnitIncrement, getSelectedText, getSelectedTextColor, getSelectionColor, getSelectionEnd, getSelectionStart, getText, getToolTipText, getUI, isEditable, loadKeymap, modelToView, moveCaretPosition, paste, print, print, print, processInputMethodEvent, read, removeCaretListener, removeKeymap, removeNotify, restoreComposedText, saveComposedText, select, selectAll, setCaret, setCaretColor, setCaretPosition, setComponentOrientation, setDisabledTextColor, setDragEnabled, setDropMode, setEditable, setFocusAccelerator, setHighlighter, setKeymap, setNavigationFilter, setSelectedTextColor, setSelectionColor, setSelectionEnd, setSelectionStart, 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, 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, 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, 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, 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, transferFocusBackward, transferFocusUpCycle

Methods inherited from class java.lang.Object

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

Constructor Detail

WebTextPane

public WebTextPane()

WebTextPane

public WebTextPane(javax.swing.text.StyledDocument doc)

WebTextPane

public WebTextPane(StyleId id)

WebTextPane

public WebTextPane(StyleId id,
                   javax.swing.text.StyledDocument doc)

Method Detail

clear

public void clear()

Clears editor text.

getInputPrompt

public java.lang.String getInputPrompt()

Returns input prompt text.

Returns:

input prompt text

setInputPrompt

public void setInputPrompt(java.lang.String text)

Sets input prompt text.

Parameters:

text - input prompt text

getStyleId

public StyleId getStyleId()

Description copied from interface: Styleable

Returns component style ID.

Specified by:

getStyleId in interface Styleable

Returns:

component style ID

setStyleId

public StyleId setStyleId(StyleId id)

Description copied from interface: Styleable

Sets new component style ID. If style for the specified ID cannot be found in skin then its default style will be used instead. This method forces component to instantly apply style with the specified ID to itself.

Specified by:

setStyleId in interface Styleable

Parameters:

id - custom component style ID

Returns:

previously used style ID

getSkin

public Skin getSkin()

Description copied from interface: Skinnable

Returns skin currently applied to this component.

Specified by:

getSkin in interface Skinnable

Returns:

skin currently applied to this component

setSkin

public Skin setSkin(Skin skin)

Description copied from interface: Skinnable

Applies specified skin to the specified component and all of its children linked via StyleId. Actual linked children information is stored within StyleData data objects. Custom skin provided using this method will not be replaced if application skin changes.

Specified by:

setSkin in interface Skinnable

Parameters:

skin - skin to be applied

Returns:

previously applied skin

setSkin

public Skin setSkin(Skin skin,
                    boolean recursively)

Description copied from interface: Skinnable

Applies specified skin to the specified component and all of its children linked via StyleId. Actual linked children information is stored within StyleData data objects. Custom skin provided using this method will not be replaced if application skin changes.

Specified by:

setSkin in interface Skinnable

Parameters:

skin - skin to be applied

recursively - whether or not should apply skin to child components

Returns:

previously applied skin

restoreSkin

public Skin restoreSkin()

Description copied from interface: Skinnable

Restores global skin for this component and all of its children linked via StyleId. Actual linked children information is stored within StyleData data objects. Restoring component skin will also include it back into the skin update cycle in case global skin will be changed.

Specified by:

restoreSkin in interface Skinnable

Returns:

skin applied to this component after restoration

addStyleListener

public void addStyleListener(StyleListener listener)

Description copied from interface: Skinnable

Adds style change listener.

Specified by:

addStyleListener in interface Skinnable

Parameters:

listener - style change listener to add

removeStyleListener

public void removeStyleListener(StyleListener listener)

Description copied from interface: Skinnable

Removes style change listener.

Specified by:

removeStyleListener in interface Skinnable

Parameters:

listener - style change listener to remove

getCustomPainters

public java.util.Map<java.lang.String,Painter> getCustomPainters()

Description copied from interface: Paintable

Returns all custom painters for this component.

Specified by:

getCustomPainters in interface Paintable

Returns:

all custom painters for this component

getCustomPainter

public Painter getCustomPainter()

Description copied from interface: Paintable

Returns custom base painter for this component.

Specified by:

getCustomPainter in interface Paintable

Returns:

custom base painter for this component

getCustomPainter

public Painter getCustomPainter(java.lang.String id)

Description copied from interface: Paintable

Returns custom painter for this component.

Specified by:

getCustomPainter in interface Paintable

Parameters:

id - painter ID

Returns:

custom painter for this component

setCustomPainter

public Painter setCustomPainter(Painter painter)

Description copied from interface: Paintable

Sets custom base painter for this component.

Specified by:

setCustomPainter in interface Paintable

Parameters:

painter - custom base painter

Returns:

previously set custom base painter

setCustomPainter

public Painter setCustomPainter(java.lang.String id,
                                Painter painter)

Description copied from interface: Paintable

Sets custom painter for this component under the specified painter ID.

Specified by:

setCustomPainter in interface Paintable

Parameters:

id - painter ID

painter - painter

Returns:

old custom painter

restoreDefaultPainters

public boolean restoreDefaultPainters()

Description copied from interface: Paintable

Restores default painters for this component.

Specified by:

restoreDefaultPainters in interface Paintable

Returns:

true if default painters were restored, false otherwise

provideShape

public java.awt.Shape provideShape()

Description copied from interface: ShapeProvider

Returns component shape.

Specified by:

provideShape in interface ShapeProvider

Returns:

component shape

getMargin

public java.awt.Insets getMargin()

Description copied from interface: MarginSupport

Returns current margin. Might return null which is basically the same as an empty [0,0,0,0] margin.

Specified by:

getMargin in interface MarginSupport

Overrides:

getMargin in class javax.swing.text.JTextComponent

Returns:

current margin

setMargin

public void setMargin(int margin)

Sets new margin.

Parameters:

margin - new margin

setMargin

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

Sets new margin.

Parameters:

top - new top margin

left - new left margin

bottom - new bottom margin

right - new right margin

setMargin

public void setMargin(java.awt.Insets margin)

Description copied from interface: MarginSupport

Sets new margin. null can be provided to set an empty [0,0,0,0] margin.

Specified by:

setMargin in interface MarginSupport

Overrides:

setMargin in class javax.swing.text.JTextComponent

Parameters:

margin - new margin

getPadding

public java.awt.Insets getPadding()

Description copied from interface: PaddingSupport

Returns current padding. Might return null which is basically the same as an empty [0,0,0,0] padding.

Specified by:

getPadding in interface PaddingSupport

Returns:

current padding

setPadding

public void setPadding(int padding)

Sets new padding.

Parameters:

padding - new padding

setPadding

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

Sets new padding.

Parameters:

top - new top padding

left - new left padding

bottom - new bottom padding

right - new right padding

setPadding

public void setPadding(java.awt.Insets padding)

Description copied from interface: PaddingSupport

Sets new padding. null can be provided to set an empty [0,0,0,0] padding.

Specified by:

setPadding in interface PaddingSupport

Parameters:

padding - new padding

updateUI

public void updateUI()

Installs a Web-UI into this component.

Overrides:

updateUI in class javax.swing.text.JTextComponent

onChange

public com.alee.utils.general.Pair<DocumentChangeListener,java.beans.PropertyChangeListener> onChange(DocumentEventRunnable runnable)

Description copied from interface: DocumentEventMethods

Shortcut method for document change event.

Specified by:

onChange in interface DocumentEventMethods

Parameters:

runnable - document event runnable

Returns:

used document change and property change listeners

onMousePress

public java.awt.event.MouseAdapter onMousePress(MouseEventRunnable runnable)

Description copied from interface: EventMethods

Shortcut method for mouse press event.

Specified by:

onMousePress in interface EventMethods

Parameters:

runnable - mouse event runnable

Returns:

used mouse adapter

onMousePress

public java.awt.event.MouseAdapter onMousePress(MouseButton mouseButton,
                                                MouseEventRunnable runnable)

Description copied from interface: EventMethods

Shortcut method for mouse press event.

Specified by:

onMousePress in interface EventMethods

Parameters:

mouseButton - mouse button filter

runnable - mouse event runnable

Returns:

used mouse adapter

onMouseEnter

public java.awt.event.MouseAdapter onMouseEnter(MouseEventRunnable runnable)

Description copied from interface: EventMethods

Shortcut method for mouse enter event.

Specified by:

onMouseEnter in interface EventMethods

Parameters:

runnable - mouse event runnable

Returns:

used mouse adapter

onMouseExit

public java.awt.event.MouseAdapter onMouseExit(MouseEventRunnable runnable)

Description copied from interface: EventMethods

Shortcut method for mouse exit event.

Specified by:

onMouseExit in interface EventMethods

Parameters:

runnable - mouse event runnable

Returns:

used mouse adapter

onMouseDrag

public java.awt.event.MouseAdapter onMouseDrag(MouseEventRunnable runnable)

Description copied from interface: EventMethods

Shortcut method for mouse drag event.

Specified by:

onMouseDrag in interface EventMethods

Parameters:

runnable - mouse event runnable

Returns:

used mouse adapter

onMouseDrag

public java.awt.event.MouseAdapter onMouseDrag(MouseButton mouseButton,
                                               MouseEventRunnable runnable)

Description copied from interface: EventMethods

Shortcut method for mouse drag event.

Specified by:

onMouseDrag in interface EventMethods

Parameters:

mouseButton - mouse button filter

runnable - mouse event runnable

Returns:

used mouse adapter

onMouseClick

public java.awt.event.MouseAdapter onMouseClick(MouseEventRunnable runnable)

Description copied from interface: EventMethods

Shortcut method for mouse click event.

Specified by:

onMouseClick in interface EventMethods

Parameters:

runnable - mouse event runnable

Returns:

used mouse adapter

onMouseClick

public java.awt.event.MouseAdapter onMouseClick(MouseButton mouseButton,
                                                MouseEventRunnable runnable)

Description copied from interface: EventMethods

Shortcut method for mouse click event.

Specified by:

onMouseClick in interface EventMethods

Parameters:

mouseButton - mouse button filter

runnable - mouse event runnable

Returns:

used mouse adapter

onDoubleClick

public java.awt.event.MouseAdapter onDoubleClick(MouseEventRunnable runnable)

Description copied from interface: EventMethods

Shortcut method for double-click mouse event.

Specified by:

onDoubleClick in interface EventMethods

Parameters:

runnable - mouse event runnable

Returns:

used mouse adapter

onMenuTrigger

public java.awt.event.MouseAdapter onMenuTrigger(MouseEventRunnable runnable)

Description copied from interface: EventMethods

Shortcut method for mouse event triggering popup menu.

Specified by:

onMenuTrigger in interface EventMethods

Parameters:

runnable - mouse event runnable

Returns:

used mouse adapter

onKeyType

public java.awt.event.KeyAdapter onKeyType(KeyEventRunnable runnable)

Description copied from interface: EventMethods

Shortcut method for key type event.

Specified by:

onKeyType in interface EventMethods

Parameters:

runnable - key event runnable

Returns:

used key adapter

onKeyType

public java.awt.event.KeyAdapter onKeyType(HotkeyData hotkey,
                                           KeyEventRunnable runnable)

Description copied from interface: EventMethods

Shortcut method for key type event.

Specified by:

onKeyType in interface EventMethods

Parameters:

hotkey - hotkey filter

runnable - key event runnable

Returns:

used key adapter

onKeyPress

public java.awt.event.KeyAdapter onKeyPress(KeyEventRunnable runnable)

Description copied from interface: EventMethods

Shortcut method for key press event.

Specified by:

onKeyPress in interface EventMethods

Parameters:

runnable - key event runnable

Returns:

used key adapter

onKeyPress

public java.awt.event.KeyAdapter onKeyPress(HotkeyData hotkey,
                                            KeyEventRunnable runnable)

Description copied from interface: EventMethods

Shortcut method for key press event.

Specified by:

onKeyPress in interface EventMethods

Parameters:

hotkey - hotkey filter

runnable - key event runnable

Returns:

used key adapter

onKeyRelease

public java.awt.event.KeyAdapter onKeyRelease(KeyEventRunnable runnable)

Description copied from interface: EventMethods

Shortcut method for key release event.

Specified by:

onKeyRelease in interface EventMethods

Parameters:

runnable - key event runnable

Returns:

used key adapter

onKeyRelease

public java.awt.event.KeyAdapter onKeyRelease(HotkeyData hotkey,
                                              KeyEventRunnable runnable)

Description copied from interface: EventMethods

Shortcut method for key release event.

Specified by:

onKeyRelease in interface EventMethods

Parameters:

hotkey - hotkey filter

runnable - key event runnable

Returns:

used key adapter

onFocusGain

public java.awt.event.FocusAdapter onFocusGain(FocusEventRunnable runnable)

Description copied from interface: EventMethods

Shortcut method for focus gain event.

Specified by:

onFocusGain in interface EventMethods

Parameters:

runnable - focus event runnable

Returns:

used focus adapter

onFocusLoss

public java.awt.event.FocusAdapter onFocusLoss(FocusEventRunnable runnable)

Description copied from interface: EventMethods

Shortcut method for focus loss event.

Specified by:

onFocusLoss in interface EventMethods

Parameters:

runnable - focus event runnable

Returns:

used focus adapter

setLanguage

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

Language methods

Specified by:

setLanguage in interface com.alee.managers.language.LanguageMethods

updateLanguage

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

Specified by:

updateLanguage in interface com.alee.managers.language.LanguageMethods

updateLanguage

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

Specified by:

updateLanguage in interface com.alee.managers.language.LanguageMethods

removeLanguage

public void removeLanguage()

Specified by:

removeLanguage in interface com.alee.managers.language.LanguageMethods

isLanguageSet

public boolean isLanguageSet()

Specified by:

isLanguageSet in interface com.alee.managers.language.LanguageMethods

setLanguageUpdater

public void setLanguageUpdater(com.alee.managers.language.updaters.LanguageUpdater updater)

Specified by:

setLanguageUpdater in interface com.alee.managers.language.LanguageMethods

removeLanguageUpdater

public void removeLanguageUpdater()

Specified by:

removeLanguageUpdater in interface com.alee.managers.language.LanguageMethods

registerSettings

public void registerSettings(java.lang.String key)

Settings methods

Specified by:

registerSettings in interface com.alee.managers.settings.SettingsMethods

registerSettings

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

Specified by:

registerSettings in interface com.alee.managers.settings.SettingsMethods

registerSettings

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

Specified by:

registerSettings in interface com.alee.managers.settings.SettingsMethods

registerSettings

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

Specified by:

registerSettings in interface com.alee.managers.settings.SettingsMethods

registerSettings

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

Specified by:

registerSettings in interface com.alee.managers.settings.SettingsMethods

registerSettings

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

Specified by:

registerSettings in interface com.alee.managers.settings.SettingsMethods

registerSettings

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

Specified by:

registerSettings in interface com.alee.managers.settings.SettingsMethods

registerSettings

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

Specified by:

registerSettings in interface com.alee.managers.settings.SettingsMethods

registerSettings

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

Specified by:

registerSettings in interface com.alee.managers.settings.SettingsMethods

registerSettings

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

Specified by:

registerSettings in interface com.alee.managers.settings.SettingsMethods

registerSettings

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

Specified by:

registerSettings in interface com.alee.managers.settings.SettingsMethods

registerSettings

public void registerSettings(com.alee.managers.settings.SettingsProcessor settingsProcessor)

Specified by:

registerSettings in interface com.alee.managers.settings.SettingsMethods

unregisterSettings

public void unregisterSettings()

Specified by:

unregisterSettings in interface com.alee.managers.settings.SettingsMethods

loadSettings

public void loadSettings()

Specified by:

loadSettings in interface com.alee.managers.settings.SettingsMethods

saveSettings

public void saveSettings()

Specified by:

saveSettings in interface com.alee.managers.settings.SettingsMethods

setPlainFont

public WebTextPane setPlainFont()

Font methods

Specified by:

setPlainFont in interface FontMethods<WebTextPane>

Returns:

modified component

setPlainFont

public WebTextPane setPlainFont(boolean apply)

Description copied from interface: FontMethods

Sets plain font for the component.

Specified by:

setPlainFont in interface FontMethods<WebTextPane>

Parameters:

apply - whether to apply font changes or not

Returns:

modified component

isPlainFont

public boolean isPlainFont()

Description copied from interface: FontMethods

Returns whether component font is plain or not.

Specified by:

isPlainFont in interface FontMethods<WebTextPane>

Returns:

true if component font is plain, false otherwise

setBoldFont

public WebTextPane setBoldFont()

Description copied from interface: FontMethods

Sets bold font for the component.

Specified by:

setBoldFont in interface FontMethods<WebTextPane>

Returns:

modified component

setBoldFont

public WebTextPane setBoldFont(boolean apply)

Description copied from interface: FontMethods

Sets bold font for the component.

Specified by:

setBoldFont in interface FontMethods<WebTextPane>

Parameters:

apply - whether to apply font changes or not

Returns:

modified component

isBoldFont

public boolean isBoldFont()

Description copied from interface: FontMethods

Returns whether component font is bold or not.

Specified by:

isBoldFont in interface FontMethods<WebTextPane>

Returns:

true if component font is bold, false otherwise

setItalicFont

public WebTextPane setItalicFont()

Description copied from interface: FontMethods

Sets italic or plain font for the component.

Specified by:

setItalicFont in interface FontMethods<WebTextPane>

Returns:

modified component

setItalicFont

public WebTextPane setItalicFont(boolean apply)

Description copied from interface: FontMethods

Sets italic or plain font for the component.

Specified by:

setItalicFont in interface FontMethods<WebTextPane>

Parameters:

apply - whether to apply font changes or not

Returns:

modified component

isItalicFont

public boolean isItalicFont()

Description copied from interface: FontMethods

Returns whether component font is italic or not.

Specified by:

isItalicFont in interface FontMethods<WebTextPane>

Returns:

true if component font is italic, false otherwise

setFontStyle

public WebTextPane setFontStyle(boolean bold,
                                boolean italic)

Description copied from interface: FontMethods

Sets component font style.

Specified by:

setFontStyle in interface FontMethods<WebTextPane>

Parameters:

bold - whether should set bold font or not

italic - whether should set italic font or not

Returns:

modified component

setFontStyle

public WebTextPane setFontStyle(int style)

Description copied from interface: FontMethods

Sets component font style.

Specified by:

setFontStyle in interface FontMethods<WebTextPane>

Parameters:

style - new style

Returns:

modified component

setFontSize

public WebTextPane setFontSize(int fontSize)

Description copied from interface: FontMethods

Sets component font size.

Specified by:

setFontSize in interface FontMethods<WebTextPane>

Parameters:

fontSize - font size

Returns:

modified component

changeFontSize

public WebTextPane changeFontSize(int change)

Description copied from interface: FontMethods

Changes font size of the specified component.

Specified by:

changeFontSize in interface FontMethods<WebTextPane>

Parameters:

change - font size change amount

Returns:

modified component

getFontSize

public int getFontSize()

Description copied from interface: FontMethods

Returns component font size.

Specified by:

getFontSize in interface FontMethods<WebTextPane>

Returns:

component font size

setFontSizeAndStyle

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

Description copied from interface: FontMethods

Sets font size and style for the specified component.

Specified by:

setFontSizeAndStyle in interface FontMethods<WebTextPane>

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 WebTextPane setFontSizeAndStyle(int fontSize,
                                       int style)

Description copied from interface: FontMethods

Sets font size and style for the specified component.

Specified by:

setFontSizeAndStyle in interface FontMethods<WebTextPane>

Parameters:

fontSize - new font size

style - new style

Returns:

modified component

setFontName

public WebTextPane setFontName(java.lang.String fontName)

Description copied from interface: FontMethods

Sets component font name.

Specified by:

setFontName in interface FontMethods<WebTextPane>

Parameters:

fontName - new font name

Returns:

modified component

getFontName

public java.lang.String getFontName()

Description copied from interface: FontMethods

Returns component font name.

Specified by:

getFontName in interface FontMethods<WebTextPane>

Returns:

component font name

getPreferredWidth

public int getPreferredWidth()

Description copied from interface: SizeMethods

Returns component preferred width.

Specified by:

getPreferredWidth in interface SizeMethods<WebTextPane>

Returns:

component preferred width

setPreferredWidth

public WebTextPane setPreferredWidth(int preferredWidth)

Description copied from interface: SizeMethods

Sets component preferred width. Pass SizeMethods.UNDEFINED to let component choose preferred width on its own.

Specified by:

setPreferredWidth in interface SizeMethods<WebTextPane>

Parameters:

preferredWidth - new component preferred width

Returns:

modified component

getPreferredHeight

public int getPreferredHeight()

Description copied from interface: SizeMethods

Returns component preferred height.

Specified by:

getPreferredHeight in interface SizeMethods<WebTextPane>

Returns:

component preferred height

setPreferredHeight

public WebTextPane setPreferredHeight(int preferredHeight)

Description copied from interface: SizeMethods

Sets component preferred height. Pass SizeMethods.UNDEFINED to let component choose preferred height on its own.

Specified by:

setPreferredHeight in interface SizeMethods<WebTextPane>

Parameters:

preferredHeight - new component preferred height

Returns:

modified component

getMinimumWidth

public int getMinimumWidth()

Description copied from interface: SizeMethods

Returns component minimum width.

Specified by:

getMinimumWidth in interface SizeMethods<WebTextPane>

Returns:

component minimum width

setMinimumWidth

public WebTextPane setMinimumWidth(int minimumWidth)

Description copied from interface: SizeMethods

Sets component minimum width. Pass SizeMethods.UNDEFINED to let component choose minimum width on its own.

Specified by:

setMinimumWidth in interface SizeMethods<WebTextPane>

Parameters:

minimumWidth - new component minimum width

Returns:

modified component

getMinimumHeight

public int getMinimumHeight()

Description copied from interface: SizeMethods

Returns component minimum height.

Specified by:

getMinimumHeight in interface SizeMethods<WebTextPane>

Returns:

component minimum height

setMinimumHeight

public WebTextPane setMinimumHeight(int minimumHeight)

Description copied from interface: SizeMethods

Sets component minimum height. Pass SizeMethods.UNDEFINED to let component choose minimum height on its own.

Specified by:

setMinimumHeight in interface SizeMethods<WebTextPane>

Parameters:

minimumHeight - new component minimum height

Returns:

modified component

getMaximumWidth

public int getMaximumWidth()

Description copied from interface: SizeMethods

Returns component maximum width.

Specified by:

getMaximumWidth in interface SizeMethods<WebTextPane>

Returns:

component maximum width

setMaximumWidth

public WebTextPane setMaximumWidth(int maximumWidth)

Description copied from interface: SizeMethods

Sets component maximum width. Pass SizeMethods.UNDEFINED to let component choose maximum width on its own.

Specified by:

setMaximumWidth in interface SizeMethods<WebTextPane>

Parameters:

maximumWidth - new component maximum width

Returns:

modified component

getMaximumHeight

public int getMaximumHeight()

Description copied from interface: SizeMethods

Returns component maximum height.

Specified by:

getMaximumHeight in interface SizeMethods<WebTextPane>

Returns:

component maximum height

setMaximumHeight

public WebTextPane setMaximumHeight(int maximumHeight)

Description copied from interface: SizeMethods

Sets component maximum height. Pass SizeMethods.UNDEFINED to let component choose maximum height on its own.

Specified by:

setMaximumHeight in interface SizeMethods<WebTextPane>

Parameters:

maximumHeight - new component maximum height

Returns:

modified component

getPreferredSize

public java.awt.Dimension getPreferredSize()

Description copied from interface: SizeMethods

Returns component preferred size.

Specified by:

getPreferredSize in interface SizeMethods<WebTextPane>

Overrides:

getPreferredSize in class javax.swing.JEditorPane

Returns:

component preferred size

setPreferredSize

public WebTextPane setPreferredSize(int width,
                                    int height)

Description copied from interface: SizeMethods

Sets component preferred size. This method is a simple bridge for JComponent#setPreferredSize method.

Specified by:

setPreferredSize in interface SizeMethods<WebTextPane>

Parameters:

width - component preferred width

height - component preferred height

Returns:

modified component