W3cubDocs

/OpenJDK 21

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 declared in class javax.swing.plaf.basic.BasicTextUI

BasicTextUI.BasicCaret, BasicTextUI.BasicHighlighter

Constructor Summary

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

Method Summary

Modifier and Type	Method	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 declared in 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 declared in class javax.swing.plaf.TextUI

getToolTipText2D, modelToView2D, viewToModel2D

Methods declared in class javax.swing.plaf.ComponentUI

contains, getAccessibleChild, getAccessibleChildrenCount, getBaseline, getBaselineResizeBehavior

Methods declared in class java.lang.Object

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

Constructor Details

BasicEditorPaneUI

public BasicEditorPaneUI()

Creates a new BasicEditorPaneUI.

Method Details

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.

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.
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.
Attaches to the editor and model. If there is no model, a default one is created.
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:

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:

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:

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

© 1993, 2023, Oracle and/or its affiliates. All rights reserved.
Documentation extracted from Debian's OpenJDK Development Kit package.
Licensed under the GNU General Public License, version 2, with the Classpath Exception.
Various third party code in OpenJDK is licensed under different licenses (see Debian package).
Java and OpenJDK are trademarks or registered trademarks of Oracle and/or its affiliates.
https://docs.oracle.com/en/java/javase/21/docs/api/java.desktop/javax/swing/plaf/basic/BasicEditorPaneUI.html