Generated by
JDiff

javax.swing.plaf.basic Documentation Differences

This file contains all the changes in documentation in the package javax.swing.plaf.basic as colored differences. Deletions are shown like this, and additions are shown like this.
If no deletions or additions are shown in an entry, the HTML tags will be what has changed. The new HTML tags are shown in the differences. If no documentation existed, and then some was added in a later version, this change is noted in the appropriate class pages of differences, but the change is not shown on this page. Only changes in existing text are shown here. Similarly, documentation which was inherited from another class or interface is not shown here.
Note that an HTML error in the new documentation may cause the display of other documentation changes to be presented incorrectly. For instance, failure to close a <code> tag will cause all subsequent paragraphs to be displayed differently.

Class BasicButtonListener

Button Listener @version 1.55 1258 04/0305/0102 @author Jeff Dinkins @author Arnaud Weber (keyboard UI support)

Class BasicColorChooserUI

Provides the basic look and feel for a JColorChooser.

@version 1.36 1238 04/0315/0102 @author Tom Santos @author Steve Wilson


Class BasicComboBoxEditor

The default editor for editable combo boxes. The editor is implemented as a JTextField. If the text field is used to edit java.lang.Number objects then its constrained to only accept numbers. @version 1.22 1224 02/0320/0102 @author Arnaud Weber @author Mark Davidson

Class BasicComboBoxUI

Basic UI implementation for JComboBox.

The combo box is a compound component which means that it is an agregate of many simpler components. This class creates and manages the listeners on the combo box and the combo box model. These listeners update the user interface in response to changes in the properties and state of the combo box.

All event handling is handled by listener classes created with the createxxxListener() methods and internal classes. You can change the behavior of this class by overriding the createxxxListener() methods and supplying your own event listeners or subclassing from the ones supplied in this class.

For adding specific actions overide installKeyboardActions to add actions in response to KeyStroke bindings. See the article Keyboard Bindings in Swing at The Swing Connection. @version 1.149 12151 04/0305/0102 @author Arnaud Weber @author Tom Santos @author Mark Davidson


Class BasicComboBoxUI.ItemHandler

This listener watches for changes to the selection in the combo box.

This public inner class should be treated as protected. Instantiate it only within subclasses of BasicComboBoxUI. @see #createItemListener


Class BasicComboBoxUI.ListDataHandler

This listener watches for changes in the ComboBoxModel.

This public inner class should be treated as protected. Instantiate it only within subclasses of BasicComboBoxUI. @see #createListDataListener


Class BasicComboBoxUI.PropertyChangeHandler

This listener watches for bound properties that have changed in the combo box.

Subclasses which wish to listen to combo box property changes should call the superclass methods to ensure that the combo box ui correctly handles property changes.

This public inner class should be treated as protected. Instantiate it only within subclasses of BasicComboBoxUI. @see #createPropertyChangeListener


Class BasicComboBoxUI, void addEditor()

This public method is implementation specific and should be private. do not call or override. To implement a specific editor create a custom ComboBoxEditor @see #createEditor @see javax.swing.JComboBox#setEditor @see javax.swing.ComboBoxEditor
Class BasicComboBoxUI, void configureArrowButton()

This public method is implementation specific and should be private. Do not call or override. @see #createArrowButton
Class BasicComboBoxUI, void configureEditor()

This protected method is implementation specific and should be private. do not call or override. @see #addEditor
Class BasicComboBoxUI, Dimension getDefaultSize()

Return the default size of an empty display area of the combo box using the current renderer and font. @return the size of an empty display area @see #getDisplaySize
Class BasicComboBoxUI, void removeEditor()

This public method is implementation specific and should be private. do not call or override. @see #addEditor
Class BasicComboBoxUI, void unconfigureArrowButton()

This public method is implementation specific and should be private. Do not call or override. @see #createArrowButton
Class BasicComboBoxUI, void unconfigureEditor()

This protected method is implementation specific and should be private. Do not call or override. @see #addEditor

Class BasicComboPopup

This is a basic implementation of the ComboPopup interface. This class represents the ui for the popup portion of the combo box.

All event handling is handled by listener classes created with the createxxxListener() methods and internal classes. You can change the behavior of this class by overriding the createxxxListener() methods and supplying your own event listeners or subclassing from the ones supplied in this class.

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 @version 1.6771 12/03/0120/02 @author Tom Santos @author Mark Davidson


Class BasicComboPopup.ListDataHandler

As of 1.4 this class is now obsolete doesn't do anything and is only included for backwards API compatibility. Do not call or override.

The functionality has been migrated into ItemHandler. @see #createItemListener


Class BasicComboPopup.PropertyChangeHandler

This listener watches for bound properties that have changed in the combo box.

Subclasses which wish to listen to combo box property changes should call the superclass methods to ensure that the combo popup correctly handles property changes. @see #createPropertyChangeListener


Class BasicComboPopup, void configureList()

Configures the list which is used to hold the combo box items in the popup. This method is called when the UI class is created. @see #createList
Class BasicComboPopup, void installComboBoxModelListeners(ComboBoxModel)

Installs the listeners on the combo box model. Any listeners installed on the combo box model should be removed in uninstallComboBoxModelListeners. @param model The combo box model to install listeners @see #uninstallComboBoxModelListeners
Class BasicComboPopup, void uninstallComboBoxModelListeners(ComboBoxModel)

Removes the listeners from the combo box model @param model The combo box model to install listeners @see #installComboBoxModelListeners

Class BasicEditorPaneUI

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 java.beans.XMLEncoder @author Timothy Prinzing @version 1.28 1229 04/0324/0102


Class BasicInternalFrameUI

A basic L&F implementation of JInternalFrame. @version 1.97 12101 06/0305/0102 @author David Kloba @author Rich Schiavi

Class BasicInternalFrameUI.GlassPaneDispatcher, void mousePressed(MouseEvent)

When inactive mouse events are forwarded as appropriate either to the UI to activate the frame or to the underlying child component. In keeping with the MDI messaging model (which JInternalFrame emulates) only the mousePressed event is forwarded to the UI to activate the frame. The mouseEntered mouseMoved and MouseExited events are forwarded to the underlying child component using methods derived from those in Container. The other mouse events are purposely ignored since they have no meaning to either the frame or its children when the frame is inactive.

Class BasicListUI

A Windows L&F implementation of ListUI.

@version 1.87 1291 02/0315/0102 @author Hans Muller @author Philip Milne


Class BasicLookAndFeel

Implements the a standard base LookAndFeel class from which standard desktop LookAndFeel classes (JLF Mac Windows etc.) can be derived. This class cannot be instantiated directly however the UI classes "Basic" defines can be.

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 @version 1.203 12206 04/0309/0102 @author unattributed


Class BasicMenuBarUI

A default L&F implementation of MenuBarUI. This implementation is a "combined" view/controller. @version 1.76 1277 04/0315/0102 @author Georges Saab @author David Karlton @author Arnaud Weber

Class BasicMenuItemUI

BasicMenuItem implementation @version 1.115 12116 04/0318/0102 @author Georges Saab @author David Karlton @author Arnaud Weber @author Fredrik Lagerblad

Class BasicMenuUI

A default L&F implementation of MenuUI. This implementation is a "combined" view/controller. @version 1.141 12144 04/0324/0102 @author Georges Saab @author David Karlton @author Arnaud Weber

Class BasicOptionPaneUI

Provides the basic look and feel for a JOptionPane. BasicMessagePaneUI provides a means to place an icon message and buttons into a Container. Generally the layout will look like:

 ------------------ | i | message | | c | message | | o | message | | n | message | ------------------ | buttons | |________________| 
icon is an instance of Icon that is wrapped inside a JLabel. The message is an opaque object and is tested for the following: if the message is a Component it is added to the Container if it is an Icon it is wrapped inside a JLabel and added to the Container otherwise it is wrapped inside a JLabel.

The above layout is used when the option pane's ComponentOrientation property is horizontal left-to-right. The layout will be adjusted appropriately for other orientations.

The Container message icon and buttons are all determined from abstract methods. @version 1.5354 12/0307/01 @author James Gosling @author Scott Violet @author Amy Fowler


Class BasicPopupMenuUI

A Windows L&F implementation of PopupMenuUI. This implementation is a "combined" view/controller. @version 1.87 1293 06/0320/0102 @author Georges Saab @author David Karlton @author Arnaud Weber

Class BasicProgressBarUI

A Basic L&F implementation of ProgressBarUI. @version 1.5860 12/03/0120/02 @author Michael C. Albers @author Kathy Walrath
Class BasicProgressBarUI, void incrementAnimationIndex()

Sets the index of the current animation frame to the next valid value which results in the progress bar being repainted. The next valid value is by default the current animation index plus one. If the new value would be too large this method sets the index to 0. Subclasses might need to override this method to ensure that the index does not go over the number of frames needed for the particular progress bar instance. This method is invoked by the default animation thread every X milliseconds where X is specified by the "ProgressBar.repaintInterval" UI default. @see #setAnimationIndex @since 1.4
Class BasicProgressBarUI, void setAnimationIndex(int)

Sets the index of the current animation frame to the specified value and requests that the progress bar be repainted. Subclasses that don't use the default painting code might need to override this method to change the way that the repaint method is invoked. @param newValue the new animation index; no checking is performed on its value @see #incrementAnimationIndex @since 1.4

Class BasicRadioButtonUI

RadioButtonUI implementation for BasicRadioButtonUI @version 1.64 1265 04/0302/0102 @author Jeff Dinkins

Class BasicRootPaneUI

Basic implementation of RootPaneUI there is one shared between all JRootPane instances. @version 1.6 128 04/0318/0102 @author Scott Violet

Class BasicScrollBarUI

Implementation of ScrollBarUI for the Basic Look and Feel @version 1.7072 12/03/0113/02 @author Rich Schiavi @author David Kloba @author Hans Muller

Class BasicScrollPaneUI

A default L&F implementation of ScrollPaneUI. @version 1.6365 12/03/0114/02 @author Hans Muller

Class BasicScrollPaneUI.MouseWheelHandler

MouseWheelHandler is an inner class which implements the MouseWheelListener interface. MouseWheelHandler responds to MouseWheelEvents by scrolling the JScrollPane appropriately. If isWheelScrollEnabled()the isscroll pane's isWheelScrollingEnabled method returns false no scrolling occurs. @see javax.swing.JScrollPane#isWheelScrollingEnabled @see #createMouseWheelListener @see java.awt.event.MouseWheelListener @see java.awt.event.MouseWheelEvent @since 1.4

Class BasicSpinnerUI

The default Spinner UI delegate. @version 1.10 12 04/1318/0102 @author Hans Muller @since 1.4

Class BasicSplitPaneUI

A Basic L&F implementation of the SplitPaneUI. @version 1.68 1272 04/0309/0102 @author Scott Violet @author Steve Wilson @author Ralph Kar

Class BasicTextAreaUI

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 JavaBeansTM has been added to the java.beans package. Please see java.beans.XMLEncoder @author Timothy Prinzing @version 1.65 1266 04/0324/0102


Class BasicTextUI

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.
  3. A less common way to create more complex types is to have the UI implementation create a. separate object for the factory. To do this the #createViewFactory method should be reimplemented to return some 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 JavaBeansTM has been added to the java.beans package. Please see java.beans.XMLEncoder @author Timothy Prinzing @version 1.75 1281 04/1224/0102


Class BasicTreeUI

The basic L&F for a hierarchical data structure.

@version 1.150 12155 04/0316/0102 @author Scott Violet