javax.swing.plaf.basic

## Class BasicEditorPaneUI

- java.lang.Object
- - javax.swing.plaf.ComponentUI
  - - javax.swing.plaf.TextUI
    - - javax.swing.plaf.basic.BasicTextUI
      - - javax.swing.plaf.basic.BasicEditorPaneUI

- All Implemented Interfaces:
    ViewFactory
  Direct Known Subclasses:
    BasicTextPaneUI, SynthEditorPaneUI

      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 JavaBeans™ 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

    Constructors
    Constructor and Description
    `BasicEditorPaneUI()` Creates a new BasicEditorPaneUI.

  - ### Method Summary

    All Methods Static Methods Instance Methods Concrete Methods
    Modifier and Type | Method and Description
    --- | ---
    `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, getBaseline, getBaselineResizeBehavior`

    - ### 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. 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 `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 `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

Submit a bug or feature
For further API reference and developer documentation, see Java SE Documentation. That documentation contains more detailed, developer-targeted descriptions, with conceptual overviews, definitions of terms, workarounds, and working code examples.
Copyright © 1993, 2017, Oracle and/or its affiliates. All rights reserved. Use is subject to license terms. Also see the documentation redistribution policy.