BasicTextAreaUI (Java Platform SE 8 ) (original) (raw)

java.lang.Object
- javax.swing.plaf.ComponentUI
- - javax.swing.plaf.TextUI
    - - javax.swing.plaf.basic.BasicTextUI
        * * javax.swing.plaf.basic.BasicTextAreaUI
All Implemented Interfaces:
ViewFactory
Direct Known Subclasses:
SynthTextAreaUI

public class BasicTextAreaUI
extends BasicTextUI
Provides the look and feel for a plain text editor. In this implementation the default UI is extended to act as a simple view factory.
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](../../../../javax/swing/plaf/basic/BasicTextUI.html "class in javax.swing.plaf.basic")  
 `[BasicTextUI.BasicCaret](../../../../javax/swing/plaf/basic/BasicTextUI.BasicCaret.html "class in javax.swing.plaf.basic"), [BasicTextUI.BasicHighlighter](../../../../javax/swing/plaf/basic/BasicTextUI.BasicHighlighter.html "class in javax.swing.plaf.basic")`

Constructor Summary

Constructors

Constructor	Description
BasicTextAreaUI()	Constructs a new BasicTextAreaUI object.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods

Modifier and Type	Method	Description
View	create(Element elem)	Creates the view for an element.
static ComponentUI	createUI(JComponent ta)	Creates a UI for a JTextArea.
int	getBaseline(JComponent c, int width, int height)	Returns the baseline.
Component.BaselineResizeBehavior	getBaselineResizeBehavior(JComponent c)	Returns an enum indicating how the baseline of the component changes as the size changes.
Dimension	getMinimumSize(JComponent c)	The method is overridden to take into account caret width.
Dimension	getPreferredSize(JComponent c)	The method is overridden to take into account caret width.
protected String	getPropertyPrefix()	Fetches the name used as a key to look up properties through the UIManager.
protected void	installDefaults()	Initializes component properties, such as font, foreground, background, caret color, selection color, selected text color, disabled text color, and border color.
protected void	propertyChange(PropertyChangeEvent evt)	This method gets called when a bound property is changed on the associated JTextComponent.

   * ### Methods inherited from class javax.swing.plaf.basic.[BasicTextUI](../../../../javax/swing/plaf/basic/BasicTextUI.html "class in javax.swing.plaf.basic")  
   `[create](../../../../javax/swing/plaf/basic/BasicTextUI.html#create-javax.swing.text.Element-int-int-), [createCaret](../../../../javax/swing/plaf/basic/BasicTextUI.html#createCaret--), [createHighlighter](../../../../javax/swing/plaf/basic/BasicTextUI.html#createHighlighter--), [createKeymap](../../../../javax/swing/plaf/basic/BasicTextUI.html#createKeymap--), [damageRange](../../../../javax/swing/plaf/basic/BasicTextUI.html#damageRange-javax.swing.text.JTextComponent-int-int-), [damageRange](../../../../javax/swing/plaf/basic/BasicTextUI.html#damageRange-javax.swing.text.JTextComponent-int-int-javax.swing.text.Position.Bias-javax.swing.text.Position.Bias-), [getComponent](../../../../javax/swing/plaf/basic/BasicTextUI.html#getComponent--), [getEditorKit](../../../../javax/swing/plaf/basic/BasicTextUI.html#getEditorKit-javax.swing.text.JTextComponent-), [getKeymapName](../../../../javax/swing/plaf/basic/BasicTextUI.html#getKeymapName--), [getMaximumSize](../../../../javax/swing/plaf/basic/BasicTextUI.html#getMaximumSize-javax.swing.JComponent-), [getNextVisualPositionFrom](../../../../javax/swing/plaf/basic/BasicTextUI.html#getNextVisualPositionFrom-javax.swing.text.JTextComponent-int-javax.swing.text.Position.Bias-int-javax.swing.text.Position.Bias:A-), [getRootView](../../../../javax/swing/plaf/basic/BasicTextUI.html#getRootView-javax.swing.text.JTextComponent-), [getToolTipText](../../../../javax/swing/plaf/basic/BasicTextUI.html#getToolTipText-javax.swing.text.JTextComponent-java.awt.Point-), [getVisibleEditorRect](../../../../javax/swing/plaf/basic/BasicTextUI.html#getVisibleEditorRect--), [installKeyboardActions](../../../../javax/swing/plaf/basic/BasicTextUI.html#installKeyboardActions--), [installListeners](../../../../javax/swing/plaf/basic/BasicTextUI.html#installListeners--), [installUI](../../../../javax/swing/plaf/basic/BasicTextUI.html#installUI-javax.swing.JComponent-), [modelChanged](../../../../javax/swing/plaf/basic/BasicTextUI.html#modelChanged--), [modelToView](../../../../javax/swing/plaf/basic/BasicTextUI.html#modelToView-javax.swing.text.JTextComponent-int-), [modelToView](../../../../javax/swing/plaf/basic/BasicTextUI.html#modelToView-javax.swing.text.JTextComponent-int-javax.swing.text.Position.Bias-), [paint](../../../../javax/swing/plaf/basic/BasicTextUI.html#paint-java.awt.Graphics-javax.swing.JComponent-), [paintBackground](../../../../javax/swing/plaf/basic/BasicTextUI.html#paintBackground-java.awt.Graphics-), [paintSafely](../../../../javax/swing/plaf/basic/BasicTextUI.html#paintSafely-java.awt.Graphics-), [setView](../../../../javax/swing/plaf/basic/BasicTextUI.html#setView-javax.swing.text.View-), [uninstallDefaults](../../../../javax/swing/plaf/basic/BasicTextUI.html#uninstallDefaults--), [uninstallKeyboardActions](../../../../javax/swing/plaf/basic/BasicTextUI.html#uninstallKeyboardActions--), [uninstallListeners](../../../../javax/swing/plaf/basic/BasicTextUI.html#uninstallListeners--), [uninstallUI](../../../../javax/swing/plaf/basic/BasicTextUI.html#uninstallUI-javax.swing.JComponent-), [update](../../../../javax/swing/plaf/basic/BasicTextUI.html#update-java.awt.Graphics-javax.swing.JComponent-), [viewToModel](../../../../javax/swing/plaf/basic/BasicTextUI.html#viewToModel-javax.swing.text.JTextComponent-java.awt.Point-), [viewToModel](../../../../javax/swing/plaf/basic/BasicTextUI.html#viewToModel-javax.swing.text.JTextComponent-java.awt.Point-javax.swing.text.Position.Bias:A-)`  
   * ### Methods inherited from class javax.swing.plaf.[ComponentUI](../../../../javax/swing/plaf/ComponentUI.html "class in javax.swing.plaf")  
   `[contains](../../../../javax/swing/plaf/ComponentUI.html#contains-javax.swing.JComponent-int-int-), [getAccessibleChild](../../../../javax/swing/plaf/ComponentUI.html#getAccessibleChild-javax.swing.JComponent-int-), [getAccessibleChildrenCount](../../../../javax/swing/plaf/ComponentUI.html#getAccessibleChildrenCount-javax.swing.JComponent-)`  
   * ### Methods inherited from class java.lang.[Object](../../../../java/lang/Object.html "class in java.lang")  
   `[clone](../../../../java/lang/Object.html#clone--), [equals](../../../../java/lang/Object.html#equals-java.lang.Object-), [finalize](../../../../java/lang/Object.html#finalize--), [getClass](../../../../java/lang/Object.html#getClass--), [hashCode](../../../../java/lang/Object.html#hashCode--), [notify](../../../../java/lang/Object.html#notify--), [notifyAll](../../../../java/lang/Object.html#notifyAll--), [toString](../../../../java/lang/Object.html#toString--), [wait](../../../../java/lang/Object.html#wait--), [wait](../../../../java/lang/Object.html#wait-long-), [wait](../../../../java/lang/Object.html#wait-long-int-)`

Constructor Detail

 * #### BasicTextAreaUI  
 public BasicTextAreaUI()  
 Constructs a new BasicTextAreaUI object.

Method Detail

* #### createUI  
public static [ComponentUI](../../../../javax/swing/plaf/ComponentUI.html "class in javax.swing.plaf") createUI([JComponent](../../../../javax/swing/JComponent.html "class in javax.swing") ta)  
Creates a UI for a JTextArea.  
Parameters:  
`ta` \- a text area  
Returns:  
the UI  
* #### getPropertyPrefix  
protected [String](../../../../java/lang/String.html "class in java.lang") getPropertyPrefix()  
Fetches 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.  
Specified by:  
`[getPropertyPrefix](../../../../javax/swing/plaf/basic/BasicTextUI.html#getPropertyPrefix--)` in class `[BasicTextUI](../../../../javax/swing/plaf/basic/BasicTextUI.html "class in javax.swing.plaf.basic")`  
Returns:  
the name ("TextArea")  
* #### installDefaults  
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.  
Overrides:  
`[installDefaults](../../../../javax/swing/plaf/basic/BasicTextUI.html#installDefaults--)` in class `[BasicTextUI](../../../../javax/swing/plaf/basic/BasicTextUI.html "class in javax.swing.plaf.basic")`  
See Also:  
[BasicTextUI.uninstallDefaults()](../../../../javax/swing/plaf/basic/BasicTextUI.html#uninstallDefaults--), [BasicTextUI.installUI(javax.swing.JComponent)](../../../../javax/swing/plaf/basic/BasicTextUI.html#installUI-javax.swing.JComponent-)  
* #### propertyChange  
protected void propertyChange([PropertyChangeEvent](../../../../java/beans/PropertyChangeEvent.html "class in java.beans") 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 View when the_WrapLine_ or the _WrapStyleWord_ property changes.  
Overrides:  
`[propertyChange](../../../../javax/swing/plaf/basic/BasicTextUI.html#propertyChange-java.beans.PropertyChangeEvent-)` in class `[BasicTextUI](../../../../javax/swing/plaf/basic/BasicTextUI.html "class in javax.swing.plaf.basic")`  
Parameters:  
`evt` \- the property change event  
* #### getPreferredSize  
public [Dimension](../../../../java/awt/Dimension.html "class in java.awt") getPreferredSize([JComponent](../../../../javax/swing/JComponent.html "class in javax.swing") c)  
The method is overridden to take into account caret width.  
Overrides:  
`[getPreferredSize](../../../../javax/swing/plaf/basic/BasicTextUI.html#getPreferredSize-javax.swing.JComponent-)` in class `[BasicTextUI](../../../../javax/swing/plaf/basic/BasicTextUI.html "class in javax.swing.plaf.basic")`  
Parameters:  
`c` \- the editor component  
Returns:  
the preferred size  
Throws:  
`[IllegalArgumentException](../../../../java/lang/IllegalArgumentException.html "class in java.lang")` \- if invalid value is passed  
Since:  
1.5  
See Also:  
[JComponent.getPreferredSize()](../../../../javax/swing/JComponent.html#getPreferredSize--), [LayoutManager.preferredLayoutSize(java.awt.Container)](../../../../java/awt/LayoutManager.html#preferredLayoutSize-java.awt.Container-)  
* #### getMinimumSize  
public [Dimension](../../../../java/awt/Dimension.html "class in java.awt") getMinimumSize([JComponent](../../../../javax/swing/JComponent.html "class in javax.swing") c)  
The method is overridden to take into account caret width.  
Overrides:  
`[getMinimumSize](../../../../javax/swing/plaf/basic/BasicTextUI.html#getMinimumSize-javax.swing.JComponent-)` in class `[BasicTextUI](../../../../javax/swing/plaf/basic/BasicTextUI.html "class in javax.swing.plaf.basic")`  
Parameters:  
`c` \- the editor component  
Returns:  
the minimum size  
Throws:  
`[IllegalArgumentException](../../../../java/lang/IllegalArgumentException.html "class in java.lang")` \- if invalid value is passed  
Since:  
1.5  
See Also:  
[JComponent.getMinimumSize()](../../../../javax/swing/JComponent.html#getMinimumSize--), [LayoutManager.minimumLayoutSize(java.awt.Container)](../../../../java/awt/LayoutManager.html#minimumLayoutSize-java.awt.Container-), [ComponentUI.getPreferredSize(javax.swing.JComponent)](../../../../javax/swing/plaf/ComponentUI.html#getPreferredSize-javax.swing.JComponent-)  
* #### create  
public [View](../../../../javax/swing/text/View.html "class in javax.swing.text") create([Element](../../../../javax/swing/text/Element.html "interface in javax.swing.text") elem)  
Creates the view for an element. Returns a WrappedPlainView or PlainView.  
Specified by:  
`[create](../../../../javax/swing/text/ViewFactory.html#create-javax.swing.text.Element-)` in interface `[ViewFactory](../../../../javax/swing/text/ViewFactory.html "interface in javax.swing.text")`  
Overrides:  
`[create](../../../../javax/swing/plaf/basic/BasicTextUI.html#create-javax.swing.text.Element-)` in class `[BasicTextUI](../../../../javax/swing/plaf/basic/BasicTextUI.html "class in javax.swing.plaf.basic")`  
Parameters:  
`elem` \- the element  
Returns:  
the view  
See Also:  
[View](../../../../javax/swing/text/View.html "class in javax.swing.text")  
* #### getBaseline  
public int getBaseline([JComponent](../../../../javax/swing/JComponent.html "class in javax.swing") c,  
                       int width,  
                       int height)  
Returns the baseline.  
Overrides:  
`[getBaseline](../../../../javax/swing/plaf/ComponentUI.html#getBaseline-javax.swing.JComponent-int-int-)` in class `[ComponentUI](../../../../javax/swing/plaf/ComponentUI.html "class in javax.swing.plaf")`  
Parameters:  
`c` \- `JComponent` baseline is being requested for  
`width` \- the width to get the baseline for  
`height` \- the height to get the baseline for  
Returns:  
baseline or a value < 0 indicating there is no reasonable baseline  
Throws:  
`[NullPointerException](../../../../java/lang/NullPointerException.html "class in java.lang")` \- if `c` is `null`  
`[IllegalArgumentException](../../../../java/lang/IllegalArgumentException.html "class in java.lang")` \- if width or height is < 0  
Since:  
1.6  
See Also:  
[JComponent.getBaseline(int, int)](../../../../javax/swing/JComponent.html#getBaseline-int-int-)  
* #### getBaselineResizeBehavior  
public [Component.BaselineResizeBehavior](../../../../java/awt/Component.BaselineResizeBehavior.html "enum in java.awt") getBaselineResizeBehavior([JComponent](../../../../javax/swing/JComponent.html "class in javax.swing") c)  
Returns an enum indicating how the baseline of the component changes as the size changes.  
Overrides:  
`[getBaselineResizeBehavior](../../../../javax/swing/plaf/ComponentUI.html#getBaselineResizeBehavior-javax.swing.JComponent-)` in class `[ComponentUI](../../../../javax/swing/plaf/ComponentUI.html "class in javax.swing.plaf")`  
Parameters:  
`c` \- `JComponent` to return baseline resize behavior for  
Returns:  
an enum indicating how the baseline changes as the component size changes  
Throws:  
`[NullPointerException](../../../../java/lang/NullPointerException.html "class in java.lang")` \- if `c` is `null`  
Since:  
1.6  
See Also:  
[JComponent.getBaseline(int, int)](../../../../javax/swing/JComponent.html#getBaseline-int-int-)

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, 2025, Oracle and/or its affiliates. All rights reserved. Use is subject to license terms. Also see the documentation redistribution policy.

BasicTextAreaUI (Java Platform SE 8 ) (original) (raw)

Nested Class Summary

Constructor Summary

Method Summary

Constructor Detail

Method Detail