All Packages  Class Hierarchy  This Package  Previous  Next  Index  

Class java.awt.swing.text.DefaultTextUI

java.lang.Object
    |
    +----java.awt.swing.plaf.ComponentUI
            |
            +----java.awt.swing.plaf.TextUI
                    |
                    +----java.awt.swing.text.DefaultTextUI

public abstract class DefaultTextUI

extends TextUI

implements ViewFactory, Serializable

Basis of a text components look-and-feel. This provides the basic editor view and controller services that may be useful when creating a look-and-feel for an extension of JTextComponent.

To minimize the effort required to build a text UI, this class does a number of things on the programmers behalf. To build a view of the model, one of the strategies can be employed.

1. One strategy is to simply redefine the ViewFactory interface in the UI. By default, this UI itself acts as the factory for View implementations. This is useful for simple factories. To do this reimplement the create method.
2. A common strategy for creating more complex types of documents is to have the EditorKit implementation return a factory. Since the EditorKit ties all of the pieces necessary to maintain a type of document, the factory is typically an important part of that and should be produced by the EditorKit implementation.
3. A less common way to create more complex types is to have the UI implementation create a. seperate object for the factory. To do this, the createViewFactory method should be reimplemented to return some factory.

Most state is held in the associated JTextComponent as bound properties, and the UI installs default values for the various properties. This default will install something for all of the properties. Typically, a LAF implementation will do more however. At a minimum, a LAF would generally install key bindings.

DefaultTextUI()

Creates a new UI.

configureComponent()

Initialize component properties, e.g.

create(Element)

If a subclass wishes to directly implement the factory producing the view(s), it should reimplement this method.

create(Element, int, int)

If a subclass wishes to directly implement the factory producing the view(s), it should reimplement this method.

createCaret()

Creates the object to use for a caret.

createController(JTextComponent)

Creates the controller responsible for binding events to actions in the text component.

createHighlighter()

Creates the object to use for adding highlights.

createKeymap()

Creates the keymap to use for the text component, and installs any necessary bindings into it.

damageRange(int, int)

Causes the portion of the view responsible for the given part of the model to be repainted.

getComponent()

Fetch the text component associated with this UI implementation.

getDefaultMargin()

Fetches the default margin space for the text ui.

getEditorKit()

Fetches the EditorKit for the UI.

getMaximumSize(JComponent)

Gets the maximum size for the editor component.

getMinimumSize(JComponent)

Gets the minimum size for the editor component.

getPreferredSize(JComponent)

Gets the preferred size for the editor component.

getPropertyPrefix()

Name used as a key to lookup properties through the UIManager.

getRootView()

Fetch a View with the allocation of the associated text component (ie the root of the hierarchy) that can be traversed to determine how the model is being represented spatially.

getVisibleEditorRect()

Gets the portion of the editor visibile on the screen.

installUI(JComponent)

Installs the UI for a component.

modelChanged()

This is called whenever the model has changed.

modelToView(int)

Converts the given location in the model to a place in the view coordinate system.

paint(Graphics, JComponent)

Paint the interface.

paintBackground(Graphics)

Paint a background for the view.

setView(View)

Set the current root of the view hierarchy.

unconfigureComponent()

Set the component properties that haven't been explicitly overriden to null.

uninstallUI(JComponent)

Deinstalls the UI for a component.

viewToModel(Point)

Converts the given place in the view coordinate system to the nearest representative location in the model.

public DefaultTextUI()

Creates a new UI.

protected TextController createController(JTextComponent c)

Creates the controller responsible for binding events to actions in the text component. By default this is an instance of JTextController.

Parameters:

c - the editor component

Returns:

the controller

protected Caret createCaret()

Creates the object to use for a caret. By default an instance of JCaret is created. This method can be redefined to provide something else that implements the InputPosition interface or a subclass of JCaret.

Returns:

the caret object

protected Highlighter createHighlighter()

Creates the object to use for adding highlights. By default an instance of JHighlighter is created. This method can be redefined to provide something else that implements the Highlighter interface or a subclass of JHighlighter.

Returns:

the highlighter

protected abstract Keymap createKeymap()

Creates the keymap to use for the text component, and installs any necessary bindings into it.

protected abstract String getPropertyPrefix()

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

protected void configureComponent()

Initialize component properties, e.g. font, foreground, and background. The font, foreground, and background properties are only set if their current value is either null or a UIResource, other properties are set if the current value is null.

See Also:

unconfigureComponent, installUI

protected void unconfigureComponent()

Set the component properties that haven't been explicitly overriden to null. A property is considered overridden if its current value is not a UIResource.

See Also:

configureComponent, uninstallUI

protected void paintBackground(Graphics g)

Paint a background for the view. This will only be called if isOpaque() on the associated component is true. The default is to paint the background color of the component.

Parameters:

g - the graphics context

protected final JTextComponent getComponent()

Fetch the text component associated with this UI implementation. This will be null until the ui has been installed.

Returns:

the component

protected void modelChanged()

This is called whenever the model has changed. It is implemented to rebuild the view hierarchy to represent the default root element of the associated model.

protected final void setView(View v)

Set the current root of the view hierarchy.

Parameters:

v - the root view

public void installUI(JComponent c)

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

1. Set the associated component to opaque (can be changed easily by a subclass or on JTextComponent directly), which is the most common case. This will cause the component's background color to be painted.
2. Install the default caret and highlighter into the associated component.
3. Attach to the editor and model. If there is no model, a default one is created.
4. create the view factory and the view hierarchy used to represent the model.
5. Create and wire up the controller.

Parameters:

c - the component

Overrides:

installUI in class ComponentUI

See Also:

installUI

public void uninstallUI(JComponent c)

Deinstalls the UI for a component.

Parameters:

c - the component

Overrides:

uninstallUI in class ComponentUI

See Also:

uninstallUI

public void paint(Graphics g,
                  JComponent c)

Paint the interface. This does the following things, rendering from back to front.

1. If the component is marked as opaque, the background is painted in the current background color of the component.
2. The highlights (if any) are painted.
3. The view hierarchy is painted.
4. The caret is painted.

Parameters:

g - the graphics context

c - the editor component

Overrides:

paint in class ComponentUI

public Dimension getPreferredSize(JComponent c)

Gets the preferred size for the editor component.

Parameters:

c - the editor component

Returns:

the size

Overrides:

getPreferredSize in class ComponentUI

public Dimension getMinimumSize(JComponent c)

Gets the minimum size for the editor component.

Parameters:

c - the editor component

Returns:

the size

Overrides:

getMinimumSize in class ComponentUI

public Dimension getMaximumSize(JComponent c)

Gets the maximum size for the editor component.

Parameters:

c - the editor component

Returns:

the size

Overrides:

getMaximumSize in class ComponentUI

protected Rectangle getVisibleEditorRect()

Gets the portion of the editor visibile on the screen.

Returns:

the bounding box for the visible portion

public Rectangle modelToView(int pos) throws BadLocationException

Converts the given location in the model to a place in the view coordinate system.

Parameters:

pos - the local location in the model to translate

Returns:

the coordinates as a rectangle

Throws: BadLocationException

if the given position does not represent a valid location in the associated document

Overrides:

modelToView in class TextUI

See Also:

modelToView

public int viewToModel(Point pt)

Converts the given place in the view coordinate system to the nearest representative location in the model.

Parameters:

pt - the location in the view to translate. This should be in the same coordinate system as the mouse events.

Returns:

the offset from the start of the document

Overrides:

viewToModel in class TextUI

See Also:

viewToModel

public void damageRange(int p0,
                        int p1)

Causes the portion of the view responsible for the given part of the model to be repainted.

Parameters:

p0 - the beginning of the range

p1 - the end of the range

Overrides:

damageRange in class TextUI

See Also:

damageRange

public EditorKit getEditorKit()

Fetches the EditorKit for the UI.

Returns:

the editor capabilities

Overrides:

getEditorKit in class TextUI

See Also:

getEditorKit

public View getRootView()

Fetch a View with the allocation of the associated text component (ie the root of the hierarchy) that can be traversed to determine how the model is being represented spatially.

Returns:

the view

Overrides:

getRootView in class TextUI

See Also:

View#getRootView

public Insets getDefaultMargin()

Fetches the default margin space for the text ui.

Returns:

the margins

Overrides:

getDefaultMargin in class TextUI

public View create(Element elem)

If a subclass wishes to directly implement the factory producing the view(s), it should reimplement this method. By default it simply returns null indicating it is unable to represent the element.

Parameters:

elem - the element

Returns:

the view

public View create(Element elem,
                   int p0,
                   int p1)

If a subclass wishes to directly implement the factory producing the view(s), it should reimplement this method. By default it simply returns null indicating it is unable to represent the part of the element.

Parameters:

elem - the element

p0 - the starting offset

p1 - the ending offset

Returns:

the view

All Packages  Class Hierarchy  This Package  Previous  Next  Index