JavaTM 2 Platform
Standard Ed. 5.0

javax.swing.plaf.basic
Class BasicEditorPaneUI

java.lang.Object
  extended by javax.swing.plaf.ComponentUI
      extended by javax.swing.plaf.TextUI
          extended by javax.swing.plaf.basic.BasicTextUI
              extended by javax.swing.plaf.basic.BasicEditorPaneUI
All Implemented Interfaces:
ViewFactory
Direct Known Subclasses:
BasicTextPaneUI

public class BasicEditorPaneUI
extends BasicTextUI

Provides the look and feel for a JEditorPane.

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


Nested Class Summary
 
Nested classes/interfaces inherited from class javax.swing.plaf.basic.BasicTextUI
BasicTextUI.BasicCaret, BasicTextUI.BasicHighlighter
 
Constructor Summary
BasicEditorPaneUI()
          Creates a new BasicEditorPaneUI.
 
Method Summary
static ComponentUI createUI(JComponent c)
          Creates a UI for the JTextPane.
 EditorKit getEditorKit(JTextComponent tc)
          Fetches the EditorKit for the UI.
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.
 void uninstallUI(JComponent c)
          Deinstalls the UI for a component.
 
Methods inherited from class javax.swing.plaf.basic.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, update, viewToModel, viewToModel
 
Methods inherited from class javax.swing.plaf.ComponentUI
contains, getAccessibleChild, getAccessibleChildrenCount
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

BasicEditorPaneUI

public BasicEditorPaneUI()
Creates a new BasicEditorPaneUI.

Method Detail

createUI

public static ComponentUI createUI(JComponent c)
Creates a UI for the JTextPane.

Parameters:
c - the JTextPane component
Returns:
the UI

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.

Specified by:
getPropertyPrefix in class BasicTextUI
Returns:
the name ("EditorPane")

installUI

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.

Overrides:
installUI in class BasicTextUI
Parameters:
c - the editor component
Since:
1.5
See Also:
ComponentUI.installUI(javax.swing.JComponent)

uninstallUI

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.

Overrides:
uninstallUI in class BasicTextUI
Parameters:
c - the editor component
Since:
1.5
See Also:
ComponentUI.uninstallUI(javax.swing.JComponent)

getEditorKit

public EditorKit getEditorKit(JTextComponent tc)
Fetches the EditorKit for the UI. This is whatever is currently set in the associated JEditorPane.

Overrides:
getEditorKit in class BasicTextUI
Parameters:
tc - the text component for which this UI is installed
Returns:
the editor capabilities
See Also:
TextUI.getEditorKit(javax.swing.text.JTextComponent)

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. This is implemented to rebuild the ActionMap based upon an EditorKit change.

Overrides:
propertyChange in class BasicTextUI
Parameters:
evt - the property change event

JavaTM 2 Platform
Standard Ed. 5.0

Submit a bug or feature
For further API reference and developer documentation, see Java 2 SDK SE Developer Documentation. That documentation contains more detailed, developer-targeted descriptions, with conceptual overviews, definitions of terms, workarounds, and working code examples.

Copyright 2004 Sun Microsystems, Inc. All rights reserved. Use is subject to license terms. Also see the documentation redistribution policy.