Class MetalScrollPaneUI

java.lang.Object

javax.swing.plaf.ComponentUI

javax.swing.plaf.ScrollPaneUI

javax.swing.plaf.basic.BasicScrollPaneUI

javax.swing.plaf.metal.MetalScrollPaneUI

All Implemented Interfaces:

ScrollPaneConstants

public class MetalScrollPaneUI
extends BasicScrollPaneUI

A Metal L&F implementation of ScrollPaneUI.

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 BasicScrollPaneUI

BasicScrollPaneUI.HSBChangeListener, BasicScrollPaneUI.MouseWheelHandler, BasicScrollPaneUI.PropertyChangeHandler, BasicScrollPaneUI.ViewportChangeHandler, BasicScrollPaneUI.VSBChangeListener

Modifier and Type	Class	Description
class	BasicScrollPaneUI.HSBChangeListener	Deprecated, for removal: This API element is subject to removal in a future version.
protected class	BasicScrollPaneUI.MouseWheelHandler	MouseWheelHandler is an inner class which implements the MouseWheelListener interface.
class	BasicScrollPaneUI.PropertyChangeHandler	Deprecated, for removal: This API element is subject to removal in a future version.
class	BasicScrollPaneUI.ViewportChangeHandler	Deprecated, for removal: This API element is subject to removal in a future version.
class	BasicScrollPaneUI.VSBChangeListener	Deprecated, for removal: This API element is subject to removal in a future version.

Field Summary

Fields inherited from class BasicScrollPaneUI

hsbChangeListener, scrollpane, spPropertyChangeListener, viewportChangeListener, vsbChangeListener

Modifier and Type	Field	Description
protected ChangeListener	hsbChangeListener	ChangeListener installed on the horizontal scrollbar.
protected JScrollPane	scrollpane	The instance of JScrollPane.
protected PropertyChangeListener	spPropertyChangeListener	PropertyChangeListener installed on the scroll pane.
protected ChangeListener	viewportChangeListener	ChangeListener installed on the viewport.
protected ChangeListener	vsbChangeListener	ChangeListener installed on the vertical scrollbar.

Fields inherited from interface ScrollPaneConstants

COLUMN_HEADER, HORIZONTAL_SCROLLBAR, HORIZONTAL_SCROLLBAR_ALWAYS, HORIZONTAL_SCROLLBAR_AS_NEEDED, HORIZONTAL_SCROLLBAR_NEVER, HORIZONTAL_SCROLLBAR_POLICY, LOWER_LEADING_CORNER, LOWER_LEFT_CORNER, LOWER_RIGHT_CORNER, LOWER_TRAILING_CORNER, ROW_HEADER, UPPER_LEADING_CORNER, UPPER_LEFT_CORNER, UPPER_RIGHT_CORNER, UPPER_TRAILING_CORNER, VERTICAL_SCROLLBAR, VERTICAL_SCROLLBAR_ALWAYS, VERTICAL_SCROLLBAR_AS_NEEDED, VERTICAL_SCROLLBAR_NEVER, VERTICAL_SCROLLBAR_POLICY, VIEWPORT

Modifier and Type	Field	Description
static final String	COLUMN_HEADER	Identifies the area at the top the viewport between the upper left corner and the upper right corner.
static final String	HORIZONTAL_SCROLLBAR	Identifies a horizontal scrollbar.
static final int	HORIZONTAL_SCROLLBAR_ALWAYS	Used to set the horizontal scroll bar policy so that horizontal scrollbars are always displayed.
static final int	HORIZONTAL_SCROLLBAR_AS_NEEDED	Used to set the horizontal scroll bar policy so that horizontal scrollbars are displayed only when needed.
static final int	HORIZONTAL_SCROLLBAR_NEVER	Used to set the horizontal scroll bar policy so that horizontal scrollbars are never displayed.
static final String	HORIZONTAL_SCROLLBAR_POLICY	Identifies the horizontal scroll bar policy property.
static final String	LOWER_LEADING_CORNER	Identifies the lower leading edge corner of the viewport.
static final String	LOWER_LEFT_CORNER	Identifies the lower left corner of the viewport.
static final String	LOWER_RIGHT_CORNER	Identifies the lower right corner of the viewport.
static final String	LOWER_TRAILING_CORNER	Identifies the lower trailing edge corner of the viewport.
static final String	ROW_HEADER	Identifies the area along the left side of the viewport between the upper left corner and the lower left corner.
static final String	UPPER_LEADING_CORNER	Identifies the upper leading edge corner of the viewport.
static final String	UPPER_LEFT_CORNER	Identifies the upper left corner of the viewport.
static final String	UPPER_RIGHT_CORNER	Identifies the upper right corner of the viewport.
static final String	UPPER_TRAILING_CORNER	Identifies the upper trailing edge corner of the viewport.
static final String	VERTICAL_SCROLLBAR	Identifies a vertical scrollbar.
static final int	VERTICAL_SCROLLBAR_ALWAYS	Used to set the vertical scroll bar policy so that vertical scrollbars are always displayed.
static final int	VERTICAL_SCROLLBAR_AS_NEEDED	Used to set the vertical scroll bar policy so that vertical scrollbars are displayed only when needed.
static final int	VERTICAL_SCROLLBAR_NEVER	Used to set the vertical scroll bar policy so that vertical scrollbars are never displayed.
static final String	VERTICAL_SCROLLBAR_POLICY	Identifies the vertical scroll bar policy property.
static final String	VIEWPORT	Identifies a "viewport" or display area, within which scrolled contents are visible.

Constructor Summary

Constructors

Constructor	Description
MetalScrollPaneUI()	Constructs a MetalScrollPaneUI.

Method Summary

Modifier and Type	Method	Description
protected PropertyChangeListener	createScrollBarSwapListener()	Returns a new PropertyChangeListener for scroll bar swap events.
static ComponentUI	createUI(JComponent x)	Constructs a new MetalScrollPaneUI.
void	installListeners(JScrollPane scrollPane)	Registers listeners.
void	installUI(JComponent c)	Configures the specified component appropriately for the look and feel.
protected void	uninstallListeners(JComponent c)	Unregisters listeners.
void	uninstallListeners(JScrollPane scrollPane)	Deprecated. - Replaced by uninstallListeners(JComponent)
void	uninstallUI(JComponent c)	Reverses configuration which was done on the specified component during installUI.

Methods inherited from class BasicScrollPaneUI

createHSBChangeListener, createMouseWheelListener, createPropertyChangeListener, createViewportChangeListener, createVSBChangeListener, getBaseline, getBaselineResizeBehavior, getMaximumSize, installDefaults, installKeyboardActions, paint, syncScrollPaneWithViewport, uninstallDefaults, uninstallKeyboardActions, updateColumnHeader, updateRowHeader, updateScrollBarDisplayPolicy, updateViewport

Modifier and Type	Method	Description
protected ChangeListener	createHSBChangeListener()	Returns an instance of horizontal scroll bar ChangeListener.
protected MouseWheelListener	createMouseWheelListener()	Creates an instance of MouseWheelListener, which is added to the JScrollPane by installUI().
protected PropertyChangeListener	createPropertyChangeListener()	Creates an instance of PropertyChangeListener that's added to the JScrollPane by installUI().
protected ChangeListener	createViewportChangeListener()	Returns an instance of viewport ChangeListener.
protected ChangeListener	createVSBChangeListener()	Returns an instance of vertical scroll bar ChangeListener.
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	getMaximumSize(JComponent c)	Returns the specified component's maximum size appropriate for the look and feel.
protected void	installDefaults(JScrollPane scrollpane)	Installs default properties.
protected void	installKeyboardActions(JScrollPane c)	Registers keyboard actions.
void	paint(Graphics g, JComponent c)	Paints the specified component appropriately for the look and feel.
protected void	syncScrollPaneWithViewport()	Synchronizes the JScrollPane with Viewport.
protected void	uninstallDefaults(JScrollPane c)	Uninstalls default properties.
protected void	uninstallKeyboardActions(JScrollPane c)	Unregisters keyboard actions.
protected void	updateColumnHeader(PropertyChangeEvent e)	Updates column header.
protected void	updateRowHeader(PropertyChangeEvent e)	Updates row header.
protected void	updateScrollBarDisplayPolicy(PropertyChangeEvent e)	Updates a scroll bar display policy.
protected void	updateViewport(PropertyChangeEvent e)	Updates viewport.

Methods inherited from class ComponentUI

contains, getAccessibleChild, getAccessibleChildrenCount, getMinimumSize, getPreferredSize, update

Modifier and Type	Method	Description
boolean	contains(JComponent c, int x, int y)	Returns true if the specified x,y location is contained within the look and feel's defined shape of the specified component.
Accessible	getAccessibleChild(JComponent c, int i)	Returns the ith Accessible child of the object.
int	getAccessibleChildrenCount(JComponent c)	Returns the number of accessible children in the object.
Dimension	getMinimumSize(JComponent c)	Returns the specified component's minimum size appropriate for the look and feel.
Dimension	getPreferredSize(JComponent c)	Returns the specified component's preferred size appropriate for the look and feel.
void	update(Graphics g, JComponent c)	Notifies this UI delegate that it is time to paint the specified component.

Methods inherited from class Object

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

Modifier and Type	Method	Description
protected Object	clone()	Creates and returns a copy of this object.
boolean	equals(Object obj)	Indicates whether some other object is "equal to" this one.
protected void	finalize()	Deprecated, for removal: This API element is subject to removal in a future version. Finalization is deprecated and subject to removal in a future release.
final Class<?>	getClass()	Returns the runtime class of this Object.
int	hashCode()	Returns a hash code value for this object.
final void	notify()	Wakes up a single thread that is waiting on this object's monitor.
final void	notifyAll()	Wakes up all threads that are waiting on this object's monitor.
String	toString()	Returns a string representation of the object.
final void	wait()	Causes the current thread to wait until it is awakened, typically by being notified or interrupted.
final void	wait(long timeoutMillis)	Causes the current thread to wait until it is awakened, typically by being notified or interrupted, or until a certain amount of real time has elapsed.
final void	wait(long timeoutMillis, int nanos)	Causes the current thread to wait until it is awakened, typically by being notified or interrupted, or until a certain amount of real time has elapsed.

Constructor Details

MetalScrollPaneUI

public MetalScrollPaneUI()

Constructs a MetalScrollPaneUI.

Method Details

createUI

public static ComponentUI createUI(JComponent x)

Constructs a new MetalScrollPaneUI.

Parameters:

x - a component

Returns:

a new MetalScrollPaneUI

installUI

public void installUI(JComponent c)

Description copied from class: ComponentUI

Configures the specified component appropriately for the look and feel. This method is invoked when the ComponentUI instance is being installed as the UI delegate on the specified component. This method should completely configure the component for the look and feel, including the following:

1. Install default property values for color, fonts, borders, icons, opacity, etc. on the component. Whenever possible, property values initialized by the client program should not be overridden.
2. Install a LayoutManager on the component if necessary.
3. Create/add any required sub-components to the component.
4. Create/install event listeners on the component.
5. Create/install a PropertyChangeListener on the component in order to detect and respond to component property changes appropriately.
6. Install keyboard UI (mnemonics, traversal, etc.) on the component.
7. Initialize any appropriate instance data.

Overrides:

installUI in class BasicScrollPaneUI

Parameters:

c - the component where this UI delegate is being installed

See Also:

• ComponentUI.uninstallUI(JComponent)
• JComponent.setUI(ComponentUI)
• JComponent.updateUI()

uninstallUI

public void uninstallUI(JComponent c)

Description copied from class: ComponentUI

Reverses configuration which was done on the specified component during installUI. This method is invoked when this UIComponent instance is being removed as the UI delegate for the specified component. This method should undo the configuration performed in installUI, being careful to leave the JComponent instance in a clean state (no extraneous listeners, look-and-feel-specific property objects, etc.). This should include the following:

1. Remove any UI-set borders from the component.
2. Remove any UI-set layout managers on the component.
3. Remove any UI-added sub-components from the component.
4. Remove any UI-added event/property listeners from the component.
5. Remove any UI-installed keyboard UI from the component.
6. Nullify any allocated instance data objects to allow for GC.

Overrides:

uninstallUI in class BasicScrollPaneUI

Parameters:

c - the component from which this UI delegate is being removed; this argument is often ignored, but might be used if the UI object is stateless and shared by multiple components

See Also:

• ComponentUI.installUI(JComponent)
• JComponent.updateUI()

installListeners

public void installListeners(JScrollPane scrollPane)

Description copied from class: BasicScrollPaneUI

Registers listeners.

Overrides:

installListeners in class BasicScrollPaneUI

Parameters:

scrollPane - an instance of JScrollPane

uninstallListeners

protected void uninstallListeners(JComponent c)

Unregisters listeners.

Overrides:

uninstallListeners in class BasicScrollPaneUI

Parameters:

c - a component

uninstallListeners

@Deprecated
public void uninstallListeners(JScrollPane scrollPane)

Deprecated.

- Replaced by uninstallListeners(JComponent)

Parameters:

scrollPane - an instance of the JScrollPane

createScrollBarSwapListener

protected PropertyChangeListener createScrollBarSwapListener()

Returns a new PropertyChangeListener for scroll bar swap events.

Returns:

a new PropertyChangeListener for scroll bar swap events.