Home » openjdk-7 » javax » swing » plaf » basic » [javadoc | source]
javax.swing.plaf.basic
abstract public class: BasicTextUI [javadoc | source]
java.lang.Object
   javax.swing.plaf.ComponentUI
      javax.swing.plaf.TextUI
         javax.swing.plaf.basic.BasicTextUI

All Implemented Interfaces:
    ViewFactory

Direct Known Subclasses:
    SynthTextFieldUI, SynthEditorPaneUI, BasicPasswordFieldUI, SynthTextAreaUI, SynthTextPaneUI, DefaultTextUI, SynthFormattedTextFieldUI, BasicTextFieldUI, BasicTextAreaUI, BasicFormattedTextFieldUI, BasicEditorPaneUI, BasicTextPaneUI, MetalTextFieldUI, SynthPasswordFieldUI

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.

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.

This class also provides some concurrency support if the Document associated with the JTextComponent is a subclass of AbstractDocument. Access to the View (or View hierarchy) is serialized between any thread mutating the model and the Swing event thread (which is expected to render, do model/view coordinate translation, etc). Any access to the root view should first acquire a read-lock on the AbstractDocument and release that lock in a finally block.

An important method to define is the #getPropertyPrefix method which is used as the basis of the keys used to fetch defaults from the UIManager. The string should reflect the type of TextUI (eg. TextField, TextArea, etc) without the particular LAF part of the name (eg Metal, Motif, etc).

To build a view of the model, one of the following 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.

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 JavaBeansTM has been added to the java.beans package. Please see java.beans.XMLEncoder .

Nested Class Summary:
public static class  BasicTextUI.BasicCaret   
public static class  BasicTextUI.BasicHighlighter   
static class  BasicTextUI.BasicCursor   
class  BasicTextUI.RootView  Root view that acts as a gateway between the component and the View hierarchy. 
class  BasicTextUI.UpdateHandler  Handles updates from various places. If the model is changed, this class unregisters as a listener to the old model and registers with the new model. If the document model changes, the change is forwarded to the root view. If the focus accelerator changes, a new keystroke is registered to request focus. 
class  BasicTextUI.TextActionWrapper  Wrapper for text actions to return isEnabled false in case editor is non editable 
class  BasicTextUI.FocusAction  Registered in the ActionMap. 
static class  BasicTextUI.DragListener  Listens for mouse events for the purposes of detecting drag gestures. BasicTextUI will maintain one of these per AppContext. 
static class  BasicTextUI.TextTransferHandler   
Field Summary
transient  JTextComponent editor     
transient  boolean painted     
transient  RootView rootView     
transient  UpdateHandler updateHandler     
Constructor:
 public BasicTextUI() 
Method from javax.swing.plaf.basic.BasicTextUI Summary:
create,   create,   createActionMap,   createCaret,   createHighlighter,   createKeymap,   damageRange,   damageRange,   getActionMap,   getComponent,   getEditorKit,   getInputMap,   getKeymapName,   getMaximumSize,   getMinimumSize,   getNextVisualPositionFrom,   getPreferredSize,   getPropertyPrefix,   getRootView,   getToolTipText,   getTransferHandler,   getVisibleEditorRect,   installDefaults,   installKeyboardActions,   installListeners,   installUI,   modelChanged,   modelToView,   modelToView,   paint,   paintBackground,   paintSafely,   propertyChange,   setView,   uninstallDefaults,   uninstallKeyboardActions,   uninstallListeners,   uninstallUI,   update,   updateFocusAcceleratorBinding,   updateFocusTraversalKeys,   viewToModel,   viewToModel
Methods from javax.swing.plaf.TextUI:
damageRange,   damageRange,   getEditorKit,   getNextVisualPositionFrom,   getRootView,   getToolTipText,   modelToView,   modelToView,   viewToModel,   viewToModel
Methods from javax.swing.plaf.ComponentUI:
contains,   createUI,   getAccessibleChild,   getAccessibleChildrenCount,   getBaseline,   getBaselineResizeBehavior,   getMaximumSize,   getMinimumSize,   getPreferredSize,   installUI,   paint,   uninstallUI,   update
Methods from java.lang.Object:
clone,   equals,   finalize,   getClass,   hashCode,   notify,   notifyAll,   toString,   wait,   wait,   wait
Method from javax.swing.plaf.basic.BasicTextUI Detail:
 public View create(Element elem) 
    Creates a view for an element. 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.
 public View create(Element elem,
    int p0,
    int p1) 
    Creates a view for an element. 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.
 ActionMap createActionMap() 
    Create a default action map. This is basically the set of actions found exported by the component.
 protected Caret createCaret() 
    Creates the object to use for a caret. By default an instance of BasicCaret is created. This method can be redefined to provide something else that implements the InputPosition interface or a subclass of JCaret.
 protected Highlighter createHighlighter() 
    Creates the object to use for adding highlights. By default an instance of BasicHighlighter is created. This method can be redefined to provide something else that implements the Highlighter interface or a subclass of DefaultHighlighter.
 protected Keymap createKeymap() 
    Creates the keymap to use for the text component, and installs any necessary bindings into it. By default, the keymap is shared between all instances of this type of TextUI. The keymap has the name defined by the getKeymapName method. If the keymap is not found, then DEFAULT_KEYMAP from JTextComponent is used.

    The set of bindings used to create the keymap is fetched from the UIManager using a key formed by combining the #getPropertyPrefix method and the string .keyBindings. The type is expected to be JTextComponent.KeyBinding[].

 public  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. Does nothing if the view is not currently painted.
 public  void damageRange(JTextComponent t,
    int p0,
    int p1,
    Bias p0Bias,
    Bias p1Bias) 
    Causes the portion of the view responsible for the given part of the model to be repainted.
 ActionMap getActionMap() 
    Fetch an action map to use.
 protected final JTextComponent getComponent() 
    Fetches the text component associated with this UI implementation. This will be null until the ui has been installed.
 public EditorKit getEditorKit(JTextComponent tc) 
    Fetches the EditorKit for the UI.
 InputMap getInputMap() 
    Get the InputMap to use for the UI.
 protected String getKeymapName() 
    Fetches the name of the keymap that will be installed/used by default for this UI. This is implemented to create a name based upon the classname. The name is the the name of the class with the package prefix removed.
 public Dimension getMaximumSize(JComponent c) 
    Gets the maximum size for the editor component.
 public Dimension getMinimumSize(JComponent c) 
    Gets the minimum size for the editor component.
 public int getNextVisualPositionFrom(JTextComponent t,
    int pos,
    Bias b,
    int direction,
    Bias[] biasRet) throws BadLocationException 
    {@inheritDoc}
 public Dimension getPreferredSize(JComponent c) 
    Gets the preferred size for the editor component. If the component has been given a size prior to receiving this request, it will set the size of the view hierarchy to reflect the size of the component before requesting the preferred size of the view hierarchy. This allows formatted views to format to the current component size before answering the request. Other views don't care about currently formatted size and give the same answer either way.
 abstract protected String getPropertyPrefix()
    Gets the name used as a key to look up properties through the UIManager. This is used as a prefix to all the standard text properties.
 public 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.

    NOTE:The View hierarchy can be traversed from the root view, and other things can be done as well. Things done in this way cannot be protected like simple method calls through the TextUI. Therefore, proper operation in the presence of concurrency must be arranged by any logic that calls this method!

 public String getToolTipText(JTextComponent t,
    Point pt) 
    Returns the string to be used as the tooltip at the passed in location. This forwards the method onto the root View.
 TransferHandler getTransferHandler() 
    Returns the TransferHandler that will be installed if their isn't one installed on the JTextComponent.
 protected Rectangle getVisibleEditorRect() 
    Gets the allocation to give the root View. Due to an unfortunate set of historical events this method is inappropriately named. The Rectangle returned has nothing to do with visibility. The component must have a non-zero positive size for this translation to be computed.
 protected  void installDefaults() 
    Initializes component properties, such as font, foreground, background, caret color, selection color, selected text color, disabled text color, and border color. 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.
 protected  void installKeyboardActions() 
 protected  void installListeners() 
    Installs listeners for the UI.
 public  void installUI(JComponent c) 
    Installs the UI for a component. This does the following things.
    1. Sets the associated component to opaque if the opaque property has not already been set by the client program. This will cause the component's background color to be painted.
    2. Installs the default caret and highlighter into the associated component. These properties are only set if their current value is either {@code 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.
 protected  void modelChanged() 
    Flags model changes. 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.
 public Rectangle modelToView(JTextComponent tc,
    int pos) throws BadLocationException 
    Converts the given location in the model to a place in the view coordinate system. The component must have a non-zero positive size for this translation to be computed.
 public Rectangle modelToView(JTextComponent tc,
    int pos,
    Bias bias) throws BadLocationException 
    Converts the given location in the model to a place in the view coordinate system. The component must have a non-zero positive size for this translation to be computed.
 public final  void paint(Graphics g,
    JComponent c) 
    Paints the interface. This is routed to the paintSafely method under the guarantee that the model won't change from the view of this thread while it's rendering (if the associated model is derived from AbstractDocument). This enables the model to potentially be updated asynchronously.
 protected  void paintBackground(Graphics g) 
    Paints 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.
 protected  void paintSafely(Graphics g) 
    Paints the interface safely with a guarantee that the model won't change from the view of this thread. 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.
 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. This is implemented to do nothing (i.e. the response to properties in JTextComponent itself are handled prior to calling this method). This implementation updates the background of the text component if the editable and/or enabled state changes.
 protected final  void setView(View v) 
    Sets the current root of the view hierarchy and calls invalidate(). If there were any child components, they will be removed (i.e. there are assumed to have come from components embedded in views).
 protected  void uninstallDefaults() 
    Sets the component properties that have not been explicitly overridden to {@code null}. A property is considered overridden if its current value is not a {@code UIResource}.
 protected  void uninstallKeyboardActions() 
 protected  void uninstallListeners() 
    Uninstalls listeners for the UI.
 public  void uninstallUI(JComponent c) 
    Deinstalls the UI for a component. This removes the listeners, uninstalls the highlighter, removes views, and nulls out the keymap.
 public  void update(Graphics g,
    JComponent c) 
    Superclass paints background in an uncontrollable way (i.e. one might want an image tiled into the background). To prevent this from happening twice, this method is reimplemented to simply paint.

    NOTE: NOTE: Superclass is also not thread-safe in its rendering of the background, although that is not an issue with the default rendering.

  void updateFocusAcceleratorBinding(boolean changed) 
    Invoked when the focus accelerator changes, this will update the key bindings as necessary.
  void updateFocusTraversalKeys() 
    Invoked when editable property is changed. removing 'TAB' and 'SHIFT-TAB' from traversalKeysSet in case editor is editable adding 'TAB' and 'SHIFT-TAB' to traversalKeysSet in case editor is non editable
 public int viewToModel(JTextComponent tc,
    Point pt) 
    Converts the given place in the view coordinate system to the nearest representative location in the model. The component must have a non-zero positive size for this translation to be computed.
 public int viewToModel(JTextComponent tc,
    Point pt,
    Bias[] biasReturn) 
    Converts the given place in the view coordinate system to the nearest representative location in the model. The component must have a non-zero positive size for this translation to be computed.