Class SynthTextPaneUI

java.lang.Object

javax.swing.plaf.ComponentUI

javax.swing.plaf.TextUI

javax.swing.plaf.basic.BasicTextUI

javax.swing.plaf.basic.BasicEditorPaneUI

javax.swing.plaf.synth.SynthEditorPaneUI

javax.swing.plaf.synth.SynthTextPaneUI

All Implemented Interfaces:

SynthConstants, SynthUI, ViewFactory

public class SynthTextPaneUI
extends SynthEditorPaneUI

Provides the look and feel for a styled text editor in the Synth look and feel.

Warning: Serialized objects of this class will not be compatible with future Swing releases. The current serialization support is appropriate for short term storage or RMI between applications running the same version of Swing. As of 1.4, support for long term storage of all JavaBeans has been added to the java.beans package. Please see XMLEncoder.

Since:

1.7

Nested Class Summary

Nested classes/interfaces declared in class BasicTextUI

BasicTextUI.BasicCaret, BasicTextUI.BasicHighlighter

Modifier and Type	Class	Description
static class	BasicTextUI.BasicCaret	Default implementation of the interface Caret.
static class	BasicTextUI.BasicHighlighter	Default implementation of the interface Highlighter.

Field Summary

Fields declared in interface SynthConstants

DEFAULT, DISABLED, ENABLED, FOCUSED, MOUSE_OVER, PRESSED, SELECTED

Modifier and Type	Field	Description
static final int	DEFAULT	Indicates the region is the default.
static final int	DISABLED	Primary state indicating the region is not enabled.
static final int	ENABLED	Primary state indicating the component is enabled.
static final int	FOCUSED	Indicates the region has focus.
static final int	MOUSE_OVER	Primary state indicating the mouse is over the region.
static final int	PRESSED	Primary state indicating the region is in a pressed state.
static final int	SELECTED	Indicates the region is selected.

Constructor Summary

Constructors

Constructor	Description
SynthTextPaneUI()	Constructs a SynthTextPaneUI.

Method Summary

Modifier and Type	Method	Description
static ComponentUI	createUI(JComponent c)	Creates a UI for the JTextPane.
protected String	getPropertyPrefix()	Fetches the name used as a key to lookup properties through the UIManager.
void	installUI(JComponent c)	Installs the UI for a component.
protected void	propertyChange(PropertyChangeEvent evt)	This method gets called when a bound property is changed on the associated JTextComponent.

Methods declared in class SynthEditorPaneUI

getContext, paint, paintBorder, update

Modifier and Type	Method	Description
SynthContext	getContext(JComponent c)	Returns the Context for the specified component.
protected void	paint(SynthContext context, Graphics g)	Paints the specified component.
void	paintBorder(SynthContext context, Graphics g, int x, int y, int w, int h)	Paints the border.
void	update(Graphics g, JComponent c)	Notifies this UI delegate to repaint the specified component.

Methods declared in class BasicEditorPaneUI

getEditorKit, uninstallUI

Modifier and Type	Method	Description
EditorKit	getEditorKit(JTextComponent tc)	Fetches the EditorKit for the UI.
void	uninstallUI(JComponent c)	Deinstalls the UI for a component.

Methods declared in class BasicTextUI

create, create, createCaret, createHighlighter, createKeymap, damageRange, damageRange, getComponent, getKeymapName, getMaximumSize, getMinimumSize, getNextVisualPositionFrom, getPreferredSize, getRootView, getToolTipText, getVisibleEditorRect, installDefaults, installKeyboardActions, installListeners, modelChanged, modelToView, modelToView, paint, paintBackground, paintSafely, setView, uninstallDefaults, uninstallKeyboardActions, uninstallListeners, viewToModel, viewToModel

Modifier and Type	Method	Description
View	create(Element elem)	Creates a view for an element.
View	create(Element elem, int p0, int p1)	Creates a view for an element.
protected Caret	createCaret()	Creates the object to use for a caret.
protected Highlighter	createHighlighter()	Creates the object to use for adding highlights.
protected Keymap	createKeymap()	Creates the keymap to use for the text component, and installs any necessary bindings into it.
void	damageRange(JTextComponent tc, int p0, int p1)	Causes the portion of the view responsible for the given part of the model to be repainted.
void	damageRange(JTextComponent t, int p0, int p1, Position.Bias p0Bias, Position.Bias p1Bias)	Causes the portion of the view responsible for the given part of the model to be repainted.
protected final JTextComponent	getComponent()	Fetches the text component associated with this UI implementation.
protected String	getKeymapName()	Fetches the name of the keymap that will be installed/used by default for this UI.
Dimension	getMaximumSize(JComponent c)	Gets the maximum size for the editor component.
Dimension	getMinimumSize(JComponent c)	Gets the minimum size for the editor component.
int	getNextVisualPositionFrom(JTextComponent t, int pos, Position.Bias b, int direction, Position.Bias[] biasRet)	Provides a way to determine the next visually represented model location that one might place a caret.
Dimension	getPreferredSize(JComponent c)	Gets the preferred size for the editor component.
View	getRootView(JTextComponent tc)	Fetches a View with the allocation of the associated text component (i.e. the root of the hierarchy) that can be traversed to determine how the model is being represented spatially.
String	getToolTipText(JTextComponent t, Point pt)	Returns the string to be used as the tooltip at the passed in location.
protected Rectangle	getVisibleEditorRect()	Gets the allocation (that is the allocated size) for the root view.
protected void	installDefaults()	Initializes component properties, such as font, foreground, background, caret color, selection color, selected text color, disabled text color, border, and margin.
protected void	installKeyboardActions()	Registers keyboard actions.
protected void	installListeners()	Installs listeners for the UI.
protected void	modelChanged()	Flags model changes.
Rectangle	modelToView(JTextComponent tc, int pos)	Deprecated. replaced by TextUI.modelToView2D(JTextComponent, int, Position.Bias)
Rectangle	modelToView(JTextComponent tc, int pos, Position.Bias bias)	Deprecated. replaced by TextUI.modelToView2D(JTextComponent, int, Position.Bias)
final void	paint(Graphics g, JComponent c)	Paints the interface.
protected void	paintBackground(Graphics g)	Paints a background for the view.
protected void	paintSafely(Graphics g)	Paints the interface safely with a guarantee that the model won't change from the view of this thread.
protected final void	setView(View v)	Sets the current root of the view hierarchy and calls invalidate().
protected void	uninstallDefaults()	Sets the component properties that have not been explicitly overridden to null.
protected void	uninstallKeyboardActions()	Unregisters keyboard actions.
protected void	uninstallListeners()	Uninstalls listeners for the UI.
int	viewToModel(JTextComponent tc, Point pt)	Deprecated. replaced by TextUI.viewToModel2D(JTextComponent, Point2D, Position.Bias[])
int	viewToModel(JTextComponent tc, Point pt, Position.Bias[] biasReturn)	Deprecated. replaced by TextUI.viewToModel2D(JTextComponent, Point2D, Position.Bias[])

Methods declared in class TextUI

getToolTipText2D, modelToView2D, viewToModel2D

Modifier and Type	Method	Description
String	getToolTipText2D(JTextComponent t, Point2D pt)	Returns the string to be used as the tooltip at the passed in location.
Rectangle2D	modelToView2D(JTextComponent t, int pos, Position.Bias bias)	Converts the given location in the model to a place in the view coordinate system.
int	viewToModel2D(JTextComponent t, Point2D pt, Position.Bias[] biasReturn)	Provides a mapping from the view coordinate space to the logical coordinate space of the model.

Methods declared in class ComponentUI

contains, getAccessibleChild, getAccessibleChildrenCount, getBaseline, getBaselineResizeBehavior

Modifier and Type	Method	Description
boolean	contains(JComponent c, int x, int y)	Returns true if the specified x,y location is contained within the look and feel's defined shape of the specified component.
Accessible	getAccessibleChild(JComponent c, int i)	Returns the ith Accessible child of the object.
int	getAccessibleChildrenCount(JComponent c)	Returns the number of accessible children in the object.
int	getBaseline(JComponent c, int width, int height)	Returns the baseline.
Component.BaselineResizeBehavior	getBaselineResizeBehavior(JComponent c)	Returns an enum indicating how the baseline of the component changes as the size changes.

Methods declared in class Object

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

Modifier and Type	Method	Description
protected Object	clone()	Creates and returns a copy of this object.
boolean	equals(Object obj)	Indicates whether some other object is "equal to" this one.
protected void	finalize()	Deprecated, for removal: This API element is subject to removal in a future version. Finalization is deprecated and subject to removal in a future release.
final Class<?>	getClass()	Returns the runtime class of this Object.
int	hashCode()	Returns a hash code value for this object.
final void	notify()	Wakes up a single thread that is waiting on this object's monitor.
final void	notifyAll()	Wakes up all threads that are waiting on this object's monitor.
String	toString()	Returns a string representation of the object.
final void	wait()	Causes the current thread to wait until it is awakened, typically by being notified or interrupted.
final void	wait(long timeoutMillis)	Causes the current thread to wait until it is awakened, typically by being notified or interrupted, or until a certain amount of real time has elapsed.
final void	wait(long timeoutMillis, int nanos)	Causes the current thread to wait until it is awakened, typically by being notified or interrupted, or until a certain amount of real time has elapsed.

Constructor Details

SynthTextPaneUI

public SynthTextPaneUI()

Constructs a SynthTextPaneUI.

Method Details

createUI

public static ComponentUI createUI(JComponent c)

Creates a UI for the JTextPane.

Parameters:

c - the JTextPane object

Returns:

the UI object

getPropertyPrefix

protected String getPropertyPrefix()

Fetches the name used as a key to lookup properties through the UIManager. This is used as a prefix to all the standard text properties.

Overrides:

getPropertyPrefix in class BasicEditorPaneUI

Returns:

the name ("TextPane")

installUI

public void installUI(JComponent c)

Installs the UI for a component. This does the following things.

1. Sets opaqueness of the associated component according to its style, if the opaque property has not already been set by the client program.
2. Installs the default caret and highlighter into the associated component. These properties are only set if their current value is either null or an instance of UIResource.
3. Attaches to the editor and model. If there is no model, a default one is created.
4. Creates the view factory and the view hierarchy used to represent the model.

Overrides:

installUI in class BasicEditorPaneUI

Parameters:

c - the editor component

See Also:

• BasicTextUI.installUI(JComponent)
• ComponentUI.installUI(JComponent)

propertyChange

protected void propertyChange(PropertyChangeEvent evt)

This method gets called when a bound property is changed on the associated JTextComponent. This is a hook which UI implementations may change to reflect how the UI displays bound properties of JTextComponent subclasses. If the font, foreground or document has changed, the the appropriate property is set in the default style of the document.

Overrides:

propertyChange in class SynthEditorPaneUI

Parameters:

evt - the property change event