JViewport (Java Platform SE 6)

This documentation differs from the official API. Jadeite adds extra features to the API including: variable font sizes, constructions examples, placeholders for classes and methods, and auto-generated “See Also” links. Additionally it is missing some items found in standard Javadoc documentation, including: generics type information, “Deprecated” tags and comments, “See Also” links, along with other minor differences. Please send any questions or feedback to bam@cs.cmu.edu.

Overview

Package

Class

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

javax.swing
class JViewport

java.lang.Object
  java.awt.Component
      java.awt.Container
          javax.swing.JComponent
              javax.swing.JViewport

All Implemented Interfaces:: MenuContainer, ImageObserver, Serializable, Accessible, TransferHandler.HasGetTransferHandler

Most common ways to construct:

JScrollPane scrollpane = …;

JViewport viewport = scrollpane.getViewport();

Based on 19 examples

JViewport viewport = new JViewport();

Based on 18 examples

public class JViewport
extends JComponent
implements Accessible

The "viewport" or "porthole" through which you see the underlying information. When you scroll, what moves is the viewport. It is like peering through a camera's viewfinder. Moving the viewfinder upwards brings new things into view at the top of the picture and loses things that were at the bottom.

By default, JViewport is opaque. To change this, use the setOpaque method.

NOTE:We have implemented a faster scrolling algorithm that does not require a buffer to draw in. The algorithm works as follows:

The view and parent view and checked to see if they are JComponents, if they aren't, stop and repaint the whole viewport.
If the viewport is obscured by an ancestor, stop and repaint the whole viewport.
Compute the region that will become visible, if it is as big as the viewport, stop and repaint the whole view region.
Obtain the ancestor Window's graphics and do a copyArea on the scrolled region.
Message the view to repaint the newly visible region.
The next time paint is invoked on the viewport, if the clip region is smaller than the viewport size a timer is kicked off to repaint the whole region.

In general this approach is much faster. Compared to the backing store approach this avoids the overhead of maintaining an offscreen buffer and having to do two copyAreas. Compared to the non backing store case this approach will greatly reduce the painted region.

This approach can cause slower times than the backing store approach when the viewport is obscured by another window, or partially offscreen. When another window obscures the viewport the copyArea will copy garbage and a paint event will be generated by the system to inform us we need to paint the newly exposed region. The only way to handle this is to repaint the whole viewport, which can cause slower performance than the backing store case. In most applications very rarely will the user be scrolling while the viewport is obscured by another window or offscreen, so this optimization is usually worth the performance hit when obscured.

Warning: Swing is not thread safe. For more information see Swing's Threading Policy.

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^TM has been added to the java.beans package. Please see {@link java.beans.XMLEncoder}.

Nested Class Summary
`protected class`	`JViewport.AccessibleJViewport` This class implements accessibility support for the `JViewport` class.
`protected class`	`JViewport.ViewListener` A listener for the view.

Nested classes/interfaces inherited from class javax.swing.JComponent
`JComponent.AccessibleJComponent`

Nested classes/interfaces inherited from class java.awt.Container
`Container.AccessibleAWTContainer`

Nested classes/interfaces inherited from class java.awt.Component
`Component.AccessibleAWTComponent, Component.BaselineResizeBehavior, Component.BltBufferStrategy, Component.FlipBufferStrategy`

Field Summary
`protected boolean`	`backingStore` True when this viewport is maintaining an offscreen image of its contents, so that some scrolling can take place using fast "bit-blit" operations instead of by accessing the view object to construct the display.
`protected transient Image`	`backingStoreImage` The view image used for a backing store.
`static int`	`BACKINGSTORE_SCROLL_MODE` Draws viewport contents into an offscreen image.
`static int`	`BLIT_SCROLL_MODE` Use `graphics.copyArea` to implement scrolling.
`protected boolean`	`isViewSizeSet` True when the viewport dimensions have been determined.
`protected Point`	`lastPaintPosition` The last `viewPosition` that we've painted, so we know how much of the backing store image is valid.
`protected boolean`	`scrollUnderway` The `scrollUnderway` flag is used for components like `JList`.
`static int`	`SIMPLE_SCROLL_MODE` This mode uses the very simple method of redrawing the entire contents of the scrollpane each time it is scrolled.

Fields inherited from class javax.swing.JComponent
`accessibleContext, listenerList, TOOL_TIP_TEXT_KEY, ui, UNDEFINED_CONDITION, WHEN_ANCESTOR_OF_FOCUSED_COMPONENT, WHEN_FOCUSED, WHEN_IN_FOCUSED_WINDOW`

Fields inherited from class java.awt.Component
`BOTTOM_ALIGNMENT, CENTER_ALIGNMENT, LEFT_ALIGNMENT, RIGHT_ALIGNMENT, TOP_ALIGNMENT`

Constructor Summary
`JViewport()` Creates a `JViewport`.

Method Summary
`void`	`addChangeListener(ChangeListener l)` Adds a `ChangeListener` to the list that is notified each time the view's size, position, or the viewport's extent size has changed.
`protected void`	`addImpl(Component child, Object constraints, int index)` Sets the `JViewport`'s one lightweight child, which can be `null`.
`protected boolean`	`computeBlit(int dx, int dy, Point blitFrom, Point blitTo, Dimension blitSize, Rectangle blitPaint)` Computes the parameters for a blit where the backing store image currently contains `oldLoc` in the upper left hand corner and we're scrolling to `newLoc`.
`protected LayoutManager`	`createLayoutManager()` Subclassers can override this to install a different layout manager (or `null`) in the constructor.
`protected JViewport.ViewListener`	`createViewListener()` Creates a listener for the view.
`protected void`	`firePropertyChange(String propertyName, Object oldValue, Object newValue)` Notifies listeners of a property change.
`protected void`	`fireStateChanged()` Notifies all `ChangeListeners` when the views size, position, or the viewports extent size has changed.
`AccessibleContext`	`getAccessibleContext()` Gets the AccessibleContext associated with this JViewport.
`ChangeListener[]`	`getChangeListeners()` Returns an array of all the `ChangeListener`s added to this JViewport with addChangeListener().
`Dimension`	`getExtentSize()` Returns the size of the visible part of the view in view coordinates.
`Insets`	`getInsets()` Returns the insets (border) dimensions as (0,0,0,0), since borders are not supported on a `JViewport`.
`Insets`	`getInsets(Insets insets)` Returns an `Insets` object containing this `JViewport`s inset values.
`int`	`getScrollMode()` Returns the current scrolling mode.
`ViewportUI`	`getUI()` Returns the L&F object that renders this component.
`String`	`getUIClassID()` Returns a string that specifies the name of the L&F class that renders this component.
`Component`	`getView()` Returns the `JViewport`'s one child or `null`.
`Point`	`getViewPosition()` Returns the view coordinates that appear in the upper left hand corner of the viewport, or 0,0 if there's no view.
`Rectangle`	`getViewRect()` Returns a rectangle whose origin is `getViewPosition` and size is `getExtentSize`.
`Dimension`	`getViewSize()` If the view's size hasn't been explicitly set, return the preferred size, otherwise return the view's current size.
`boolean`	`isBackingStoreEnabled()` Returns `true` if this viewport is maintaining an offscreen image of its contents.
`boolean`	`isOptimizedDrawingEnabled()` The `JViewport` overrides the default implementation of this method (in `JComponent`) to return false.
`void`	`paint(Graphics g)` Depending on whether the `backingStore` is enabled, either paint the image through the backing store or paint just the recently exposed part, using the backing store to "blit" the remainder.
`protected String`	`paramString()` Returns a string representation of this `JViewport`.
`void`	`remove(Component child)` Removes the `Viewport`s one lightweight child.
`void`	`removeChangeListener(ChangeListener l)` Removes a `ChangeListener` from the list that's notified each time the views size, position, or the viewports extent size has changed.
`void`	`repaint(long tm, int x, int y, int w, int h)` Always repaint in the parents coordinate system to make sure only one paint is performed by the `RepaintManager`.
`void`	`reshape(int x, int y, int w, int h)` Sets the bounds of this viewport.
`void`	`scrollRectToVisible(Rectangle contentRect)` Scrolls the view so that `Rectangle` within the view becomes visible.
`void`	`setBackingStoreEnabled(boolean enabled)` If true if this viewport will maintain an offscreen image of its contents.
`void`	`setBorder(Border border)` The viewport "scrolls" its child (called the "view") by the normal parent/child clipping (typically the view is moved in the opposite direction of the scroll).
`void`	`setExtentSize(Dimension newExtent)` Sets the size of the visible part of the view using view coordinates.
`void`	`setScrollMode(int mode)` Used to control the method of scrolling the viewport contents.
`void`	`setUI(ViewportUI ui)` Sets the L&F object that renders this component.
`void`	`setView(Component view)` Sets the `JViewport`'s one lightweight child (`view`), which can be `null`.
`void`	`setViewPosition(Point p)` Sets the view coordinates that appear in the upper left hand corner of the viewport, does nothing if there's no view.
`void`	`setViewSize(Dimension newSize)` Sets the size of the view.
`Dimension`	`toViewCoordinates(Dimension size)` Converts a size in pixel coordinates to view coordinates.
`Point`	`toViewCoordinates(Point p)` Converts a point in pixel coordinates to view coordinates.
`void`	`updateUI()` Resets the UI property to a value from the current look and feel.

Methods inherited from class javax.swing.JComponent
addAncestorListener, addNotify, addVetoableChangeListener, computeVisibleRect, contains, createToolTip, disable, enable, firePropertyChange, firePropertyChange, firePropertyChange, fireVetoableChange, getAccessibleContext, getActionForKeyStroke, getActionMap, getAlignmentX, getAlignmentY, getAncestorListeners, getAutoscrolls, getBaseline, getBaselineResizeBehavior, getBorder, getBounds, getClientProperty, getComponentGraphics, getComponentPopupMenu, getConditionForKeyStroke, getDebugGraphicsOptions, getDefaultLocale, getFontMetrics, getGraphics, getHeight, getInheritsPopupMenu, getInputMap, getInputMap, getInputVerifier, getInsets, getInsets, getListeners, getLocation, getMaximumSize, getMinimumSize, getNextFocusableComponent, getPopupLocation, getPreferredSize, getRegisteredKeyStrokes, getRootPane, getSize, getToolTipLocation, getToolTipText, getToolTipText, getTopLevelAncestor, getTransferHandler, getUIClassID, getVerifyInputWhenFocusTarget, getVetoableChangeListeners, getVisibleRect, getWidth, getX, getY, grabFocus, isDoubleBuffered, isLightweightComponent, isManagingFocus, isOpaque, isOptimizedDrawingEnabled, isPaintingForPrint, isPaintingTile, isRequestFocusEnabled, isValidateRoot, paint, paintBorder, paintChildren, paintComponent, paintImmediately, paintImmediately, paramString, print, printAll, printBorder, printChildren, printComponent, processComponentKeyEvent, processKeyBinding, processKeyEvent, processMouseEvent, processMouseMotionEvent, putClientProperty, registerKeyboardAction, registerKeyboardAction, removeAncestorListener, removeNotify, removeVetoableChangeListener, repaint, repaint, requestDefaultFocus, requestFocus, requestFocus, requestFocusInWindow, requestFocusInWindow, resetKeyboardActions, reshape, revalidate, scrollRectToVisible, setActionMap, setAlignmentX, setAlignmentY, setAutoscrolls, setBackground, setBorder, setComponentPopupMenu, setDebugGraphicsOptions, setDefaultLocale, setDoubleBuffered, setEnabled, setFocusTraversalKeys, setFont, setForeground, setInheritsPopupMenu, setInputMap, setInputVerifier, setMaximumSize, setMinimumSize, setNextFocusableComponent, setOpaque, setPreferredSize, setRequestFocusEnabled, setToolTipText, setTransferHandler, setUI, setVerifyInputWhenFocusTarget, setVisible, unregisterKeyboardAction, update, updateUI

Methods inherited from class javax.swing.JComponent


addAncestorListener, addNotify, addVetoableChangeListener, computeVisibleRect, contains, createToolTip, disable, enable, firePropertyChange, firePropertyChange, firePropertyChange, fireVetoableChange, getAccessibleContext, getActionForKeyStroke, getActionMap, getAlignmentX, getAlignmentY, getAncestorListeners, getAutoscrolls, getBaseline, getBaselineResizeBehavior, getBorder, getBounds, getClientProperty, getComponentGraphics, getComponentPopupMenu, getConditionForKeyStroke, getDebugGraphicsOptions, getDefaultLocale, getFontMetrics, getGraphics, getHeight, getInheritsPopupMenu, getInputMap, getInputMap, getInputVerifier, getInsets, getInsets, getListeners, getLocation, getMaximumSize, getMinimumSize, getNextFocusableComponent, getPopupLocation, getPreferredSize, getRegisteredKeyStrokes, getRootPane, getSize, getToolTipLocation, getToolTipText, getToolTipText, getTopLevelAncestor, getTransferHandler, getUIClassID, getVerifyInputWhenFocusTarget, getVetoableChangeListeners, getVisibleRect, getWidth, getX, getY, grabFocus, isDoubleBuffered, isLightweightComponent, isManagingFocus, isOpaque, isOptimizedDrawingEnabled, isPaintingForPrint, isPaintingTile, isRequestFocusEnabled, isValidateRoot, paint, paintBorder, paintChildren, paintComponent, paintImmediately, paintImmediately, paramString, print, printAll, printBorder, printChildren, printComponent, processComponentKeyEvent, processKeyBinding, processKeyEvent, processMouseEvent, processMouseMotionEvent, putClientProperty, registerKeyboardAction, registerKeyboardAction, removeAncestorListener, removeNotify, removeVetoableChangeListener, repaint, repaint, requestDefaultFocus, requestFocus, requestFocus, requestFocusInWindow, requestFocusInWindow, resetKeyboardActions, reshape, revalidate, scrollRectToVisible, setActionMap, setAlignmentX, setAlignmentY, setAutoscrolls, setBackground, setBorder, setComponentPopupMenu, setDebugGraphicsOptions, setDefaultLocale, setDoubleBuffered, setEnabled, setFocusTraversalKeys, setFont, setForeground, setInheritsPopupMenu, setInputMap, setInputVerifier, setMaximumSize, setMinimumSize, setNextFocusableComponent, setOpaque, setPreferredSize, setRequestFocusEnabled, setToolTipText, setTransferHandler, setUI, setVerifyInputWhenFocusTarget, setVisible, unregisterKeyboardAction, update, updateUI

Methods inherited from class java.awt.Container
add, add, add, add, add, addContainerListener, addImpl, addNotify, addPropertyChangeListener, addPropertyChangeListener, applyComponentOrientation, areFocusTraversalKeysSet, countComponents, deliverEvent, doLayout, findComponentAt, findComponentAt, getAlignmentX, getAlignmentY, getComponent, getComponentAt, getComponentAt, getComponentCount, getComponents, getComponentZOrder, getContainerListeners, getFocusTraversalKeys, getFocusTraversalPolicy, getInsets, getLayout, getListeners, getMaximumSize, getMinimumSize, getMousePosition, getPreferredSize, insets, invalidate, isAncestorOf, isFocusCycleRoot, isFocusCycleRoot, isFocusTraversalPolicyProvider, isFocusTraversalPolicySet, layout, list, list, locate, minimumSize, paint, paintComponents, paramString, preferredSize, print, printComponents, processContainerEvent, processEvent, remove, remove, removeAll, removeContainerListener, removeNotify, setComponentZOrder, setFocusCycleRoot, setFocusTraversalKeys, setFocusTraversalPolicy, setFocusTraversalPolicyProvider, setFont, setLayout, transferFocusBackward, transferFocusDownCycle, update, validate, validateTree

Methods inherited from class java.awt.Container


add, add, add, add, add, addContainerListener, addImpl, addNotify, addPropertyChangeListener, addPropertyChangeListener, applyComponentOrientation, areFocusTraversalKeysSet, countComponents, deliverEvent, doLayout, findComponentAt, findComponentAt, getAlignmentX, getAlignmentY, getComponent, getComponentAt, getComponentAt, getComponentCount, getComponents, getComponentZOrder, getContainerListeners, getFocusTraversalKeys, getFocusTraversalPolicy, getInsets, getLayout, getListeners, getMaximumSize, getMinimumSize, getMousePosition, getPreferredSize, insets, invalidate, isAncestorOf, isFocusCycleRoot, isFocusCycleRoot, isFocusTraversalPolicyProvider, isFocusTraversalPolicySet, layout, list, list, locate, minimumSize, paint, paintComponents, paramString, preferredSize, print, printComponents, processContainerEvent, processEvent, remove, remove, removeAll, removeContainerListener, removeNotify, setComponentZOrder, setFocusCycleRoot, setFocusTraversalKeys, setFocusTraversalPolicy, setFocusTraversalPolicyProvider, setFont, setLayout, transferFocusBackward, transferFocusDownCycle, update, validate, validateTree

Methods inherited from class java.awt.Component
action, add, addComponentListener, addFocusListener, addHierarchyBoundsListener, addHierarchyListener, addInputMethodListener, addKeyListener, addMouseListener, addMouseMotionListener, addMouseWheelListener, addNotify, addPropertyChangeListener, addPropertyChangeListener, applyComponentOrientation, areFocusTraversalKeysSet, bounds, checkImage, checkImage, coalesceEvents, contains, contains, createImage, createImage, createVolatileImage, createVolatileImage, deliverEvent, disable, disableEvents, dispatchEvent, doLayout, enable, enable, enableEvents, enableInputMethods, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, getAccessibleContext, getAlignmentX, getAlignmentY, getBackground, getBaseline, getBaselineResizeBehavior, getBounds, getBounds, getColorModel, getComponentAt, getComponentAt, getComponentListeners, getComponentOrientation, getCursor, getDropTarget, getFocusCycleRootAncestor, getFocusListeners, getFocusTraversalKeys, getFocusTraversalKeysEnabled, getFont, getFontMetrics, getForeground, getGraphics, getGraphicsConfiguration, getHeight, getHierarchyBoundsListeners, getHierarchyListeners, getIgnoreRepaint, getInputContext, getInputMethodListeners, getInputMethodRequests, getKeyListeners, getListeners, getLocale, getLocation, getLocation, getLocationOnScreen, getMaximumSize, getMinimumSize, getMouseListeners, getMouseMotionListeners, getMousePosition, getMouseWheelListeners, getName, getParent, getPeer, getPreferredSize, getPropertyChangeListeners, getPropertyChangeListeners, getSize, getSize, getToolkit, getTreeLock, getWidth, getX, getY, gotFocus, handleEvent, hasFocus, hide, imageUpdate, inside, invalidate, isBackgroundSet, isCursorSet, isDisplayable, isDoubleBuffered, isEnabled, isFocusable, isFocusCycleRoot, isFocusOwner, isFocusTraversable, isFontSet, isForegroundSet, isLightweight, isMaximumSizeSet, isMinimumSizeSet, isOpaque, isPreferredSizeSet, isShowing, isValid, isVisible, keyDown, keyUp, layout, list, list, list, list, list, locate, location, lostFocus, minimumSize, mouseDown, mouseDrag, mouseEnter, mouseExit, mouseMove, mouseUp, move, nextFocus, paint, paintAll, paramString, postEvent, preferredSize, prepareImage, prepareImage, print, printAll, processComponentEvent, processEvent, processFocusEvent, processHierarchyBoundsEvent, processHierarchyEvent, processInputMethodEvent, processKeyEvent, processMouseEvent, processMouseMotionEvent, processMouseWheelEvent, remove, removeComponentListener, removeFocusListener, removeHierarchyBoundsListener, removeHierarchyListener, removeInputMethodListener, removeKeyListener, removeMouseListener, removeMouseMotionListener, removeMouseWheelListener, removeNotify, removePropertyChangeListener, removePropertyChangeListener, repaint, repaint, repaint, repaint, requestFocus, requestFocus, requestFocusInWindow, requestFocusInWindow, reshape, resize, resize, setBackground, setBounds, setBounds, setComponentOrientation, setCursor, setDropTarget, setEnabled, setFocusable, setFocusTraversalKeys, setFocusTraversalKeysEnabled, setFont, setForeground, setIgnoreRepaint, setLocale, setLocation, setLocation, setMaximumSize, setMinimumSize, setName, setPreferredSize, setSize, setSize, setVisible, show, show, size, toString, transferFocus, transferFocusBackward, transferFocusUpCycle, update, validate

Methods inherited from class java.awt.Component


action, add, addComponentListener, addFocusListener, addHierarchyBoundsListener, addHierarchyListener, addInputMethodListener, addKeyListener, addMouseListener, addMouseMotionListener, addMouseWheelListener, addNotify, addPropertyChangeListener, addPropertyChangeListener, applyComponentOrientation, areFocusTraversalKeysSet, bounds, checkImage, checkImage, coalesceEvents, contains, contains, createImage, createImage, createVolatileImage, createVolatileImage, deliverEvent, disable, disableEvents, dispatchEvent, doLayout, enable, enable, enableEvents, enableInputMethods, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, getAccessibleContext, getAlignmentX, getAlignmentY, getBackground, getBaseline, getBaselineResizeBehavior, getBounds, getBounds, getColorModel, getComponentAt, getComponentAt, getComponentListeners, getComponentOrientation, getCursor, getDropTarget, getFocusCycleRootAncestor, getFocusListeners, getFocusTraversalKeys, getFocusTraversalKeysEnabled, getFont, getFontMetrics, getForeground, getGraphics, getGraphicsConfiguration, getHeight, getHierarchyBoundsListeners, getHierarchyListeners, getIgnoreRepaint, getInputContext, getInputMethodListeners, getInputMethodRequests, getKeyListeners, getListeners, getLocale, getLocation, getLocation, getLocationOnScreen, getMaximumSize, getMinimumSize, getMouseListeners, getMouseMotionListeners, getMousePosition, getMouseWheelListeners, getName, getParent, getPeer, getPreferredSize, getPropertyChangeListeners, getPropertyChangeListeners, getSize, getSize, getToolkit, getTreeLock, getWidth, getX, getY, gotFocus, handleEvent, hasFocus, hide, imageUpdate, inside, invalidate, isBackgroundSet, isCursorSet, isDisplayable, isDoubleBuffered, isEnabled, isFocusable, isFocusCycleRoot, isFocusOwner, isFocusTraversable, isFontSet, isForegroundSet, isLightweight, isMaximumSizeSet, isMinimumSizeSet, isOpaque, isPreferredSizeSet, isShowing, isValid, isVisible, keyDown, keyUp, layout, list, list, list, list, list, locate, location, lostFocus, minimumSize, mouseDown, mouseDrag, mouseEnter, mouseExit, mouseMove, mouseUp, move, nextFocus, paint, paintAll, paramString, postEvent, preferredSize, prepareImage, prepareImage, print, printAll, processComponentEvent, processEvent, processFocusEvent, processHierarchyBoundsEvent, processHierarchyEvent, processInputMethodEvent, processKeyEvent, processMouseEvent, processMouseMotionEvent, processMouseWheelEvent, remove, removeComponentListener, removeFocusListener, removeHierarchyBoundsListener, removeHierarchyListener, removeInputMethodListener, removeKeyListener, removeMouseListener, removeMouseMotionListener, removeMouseWheelListener, removeNotify, removePropertyChangeListener, removePropertyChangeListener, repaint, repaint, repaint, repaint, requestFocus, requestFocus, requestFocusInWindow, requestFocusInWindow, reshape, resize, resize, setBackground, setBounds, setBounds, setComponentOrientation, setCursor, setDropTarget, setEnabled, setFocusable, setFocusTraversalKeys, setFocusTraversalKeysEnabled, setFont, setForeground, setIgnoreRepaint, setLocale, setLocation, setLocation, setMaximumSize, setMinimumSize, setName, setPreferredSize, setSize, setSize, setVisible, show, show, size, toString, transferFocus, transferFocusBackward, transferFocusUpCycle, update, validate

Methods inherited from class java.lang.Object
`clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait`

Field Detail

backingStore

protected boolean backingStore

True when this viewport is maintaining an offscreen image of its contents, so that some scrolling can take place using fast "bit-blit" operations instead of by accessing the view object to construct the display. The default is false.

backingStoreImage

protected transient Image backingStoreImage

The view image used for a backing store.

BACKINGSTORE_SCROLL_MODE

public static final int BACKINGSTORE_SCROLL_MODE

Draws viewport contents into an offscreen image. This was previously the default mode for JTable. This mode may offer advantages over "blit mode" in some cases, but it requires a large chunk of extra RAM.

BLIT_SCROLL_MODE

public static final int BLIT_SCROLL_MODE

Use graphics.copyArea to implement scrolling. This is the fastest for most applications.

isViewSizeSet

protected boolean isViewSizeSet

True when the viewport dimensions have been determined. The default is false.

lastPaintPosition

protected Point lastPaintPosition

The last viewPosition that we've painted, so we know how much of the backing store image is valid.

scrollUnderway

protected boolean scrollUnderway

The scrollUnderway flag is used for components like JList. When the downarrow key is pressed on a JList and the selected cell is the last in the list, the scrollpane autoscrolls. Here, the old selected cell needs repainting and so we need a flag to make the viewport do the optimized painting only when there is an explicit call to setViewPosition(Point). When setBounds is called through other routes, the flag is off and the view repaints normally. Another approach would be to remove this from the JViewport class and have the JList manage this case by using setBackingStoreEnabled. The default is false.

SIMPLE_SCROLL_MODE

public static final int SIMPLE_SCROLL_MODE

This mode uses the very simple method of redrawing the entire contents of the scrollpane each time it is scrolled. This was the default behavior in Swing 1.0 and Swing 1.1. Either of the other two options will provide better performance in most cases.

Constructor Detail

JViewport

public JViewport()

Creates a JViewport.

Method Detail

addChangeListener

public void addChangeListener(ChangeListener l)

Adds a ChangeListener to the list that is notified each time the view's size, position, or the viewport's extent size has changed.

Parameters:: l - the ChangeListener to add

addImpl

protected void addImpl(Component child,
                       Object constraints,
                       int index)

Sets the JViewport's one lightweight child, which can be null. (Since there is only one child which occupies the entire viewport, the constraints and index arguments are ignored.)

Overrides:: addImpl in class Container
Parameters:: child - the lightweight child of the viewport; constraints - the constraints to be respected; index - the index

computeBlit

protected boolean computeBlit(int dx,
                              int dy,
                              Point blitFrom,
                              Point blitTo,
                              Dimension blitSize,
                              Rectangle blitPaint)

Computes the parameters for a blit where the backing store image currently contains oldLoc in the upper left hand corner and we're scrolling to newLoc. The parameters are modified to return the values required for the blit.

Parameters:: dx - the horizontal delta; dy - the vertical delta; blitFrom - the Point we're blitting from; blitTo - the Point we're blitting to; blitSize - the Dimension of the area to blit; blitPaint - the area to blit
Returns:: true if the parameters are modified and we're ready to blit; false otherwise

createLayoutManager

protected LayoutManager createLayoutManager()

Subclassers can override this to install a different layout manager (or null) in the constructor. Returns the LayoutManager to install on the JViewport.

Returns:: a LayoutManager

createViewListener

protected JViewport.ViewListener createViewListener()

Creates a listener for the view.

Returns:: a ViewListener

firePropertyChange

protected void firePropertyChange(String propertyName,
                                  Object oldValue,
                                  Object newValue)

Notifies listeners of a property change. This is subclassed to update the windowBlit property. (The putClientProperty property is final).

Overrides:: firePropertyChange in class Component
Parameters:: propertyName - a string containing the property name; oldValue - the old value of the property; newValue - the new value of the property

fireStateChanged

protected void fireStateChanged()

Notifies all ChangeListeners when the views size, position, or the viewports extent size has changed.

getAccessibleContext

public AccessibleContext getAccessibleContext()

Gets the AccessibleContext associated with this JViewport. For viewports, the AccessibleContext takes the form of an AccessibleJViewport. A new AccessibleJViewport instance is created if necessary.

Overrides:: getAccessibleContext in class JComponent
Returns:: an AccessibleJViewport that serves as the AccessibleContext of this JViewport

getChangeListeners

public ChangeListener[] getChangeListeners()

Returns an array of all the ChangeListeners added to this JViewport with addChangeListener().

Returns:: all of the ChangeListeners added or an empty array if no listeners have been added

getExtentSize

public Dimension getExtentSize()

Returns the size of the visible part of the view in view coordinates.

Returns:: a Dimension object giving the size of the view

getInsets

public final Insets getInsets()

Returns the insets (border) dimensions as (0,0,0,0), since borders are not supported on a JViewport.

Overrides:: getInsets in class JComponent
Returns:: a Rectange of zero dimension and zero origin

getInsets

public final Insets getInsets(Insets insets)

Returns an Insets object containing this JViewports inset values. The passed-in Insets object will be reinitialized, and all existing values within this object are overwritten.

Overrides:: getInsets in class JComponent
Parameters:: insets - the Insets object which can be reused
Returns:: this viewports inset values

getScrollMode

public int getScrollMode()

Returns the current scrolling mode.

Returns:: the scrollMode property

getUI

public ViewportUI getUI()

Returns the L&F object that renders this component.

Returns:: a ViewportUI object

getUIClassID

public String getUIClassID()

Returns a string that specifies the name of the L&F class that renders this component.

Overrides:: getUIClassID in class JComponent
Returns:: the string "ViewportUI"

getView

public Component getView()

Returns the JViewport's one child or null.

Returns:: the viewports child, or null if none exists

getViewPosition

public Point getViewPosition()

Returns the view coordinates that appear in the upper left hand corner of the viewport, or 0,0 if there's no view.

Returns:: a Point object giving the upper left coordinates

getViewRect

public Rectangle getViewRect()

Returns a rectangle whose origin is getViewPosition and size is getExtentSize. This is the visible part of the view, in view coordinates.

Returns:: a Rectangle giving the visible part of the view using view coordinates.

getViewSize

public Dimension getViewSize()

If the view's size hasn't been explicitly set, return the preferred size, otherwise return the view's current size. If there is no view, return 0,0.

Returns:: a Dimension object specifying the size of the view

isBackingStoreEnabled

public boolean isBackingStoreEnabled()

Returns true if this viewport is maintaining an offscreen image of its contents.

Returns:: true if scrollMode is BACKINGSTORE_SCROLL_MODE

isOptimizedDrawingEnabled

public boolean isOptimizedDrawingEnabled()

The JViewport overrides the default implementation of this method (in JComponent) to return false. This ensures that the drawing machinery will call the Viewport's paint implementation rather than messaging the JViewport's children directly.

Overrides:: isOptimizedDrawingEnabled in class JComponent
Returns:: false

paint

public void paint(Graphics g)

Depending on whether the backingStore is enabled, either paint the image through the backing store or paint just the recently exposed part, using the backing store to "blit" the remainder.

The term "blit" is the pronounced version of the PDP-10 BLT (BLock Transfer) instruction, which copied a block of bits. (In case you were curious.)

Overrides:: paint in class JComponent
Parameters:: g - the Graphics context within which to paint

paramString

protected String paramString()

Returns a string representation of this JViewport. This method is intended to be used only for debugging purposes, and the content and format of the returned string may vary between implementations. The returned string may be empty but may not be null.

Overrides:: paramString in class JComponent
Returns:: a string representation of this JViewport

remove

public void remove(Component child)

Removes the Viewports one lightweight child.

Overrides:: remove in class Container
Parameters:: child

removeChangeListener

public void removeChangeListener(ChangeListener l)

Removes a ChangeListener from the list that's notified each time the views size, position, or the viewports extent size has changed.

Parameters:: l - the ChangeListener to remove

repaint

public void repaint(long tm,
                    int x,
                    int y,
                    int w,
                    int h)

Always repaint in the parents coordinate system to make sure only one paint is performed by the RepaintManager.

Overrides:: repaint in class JComponent
Parameters:: tm - maximum time in milliseconds before update; x - the x coordinate (pixels over from left); y - the y coordinate (pixels down from top); w - the width; h - the height

reshape

public void reshape(int x,
                    int y,
                    int w,
                    int h)

Sets the bounds of this viewport. If the viewport's width or height has changed, fire a StateChanged event.

Overrides:: reshape in class JComponent
Parameters:: x - left edge of the origin; y - top edge of the origin; w - width in pixels; h - height in pixels

scrollRectToVisible

public void scrollRectToVisible(Rectangle contentRect)

Scrolls the view so that Rectangle within the view becomes visible.

This attempts to validate the view before scrolling if the view is currently not valid - isValid returns false. To avoid excessive validation when the containment hierarchy is being created this will not validate if one of the ancestors does not have a peer, or there is no validate root ancestor, or one of the ancestors is not a Window or Applet.

Note that this method will not scroll outside of the valid viewport; for example, if contentRect is larger than the viewport, scrolling will be confined to the viewport's bounds.

Overrides:: scrollRectToVisible in class JComponent
Parameters:: contentRect - the Rectangle to display

setBackingStoreEnabled

public void setBackingStoreEnabled(boolean enabled)

If true if this viewport will maintain an offscreen image of its contents. The image is used to reduce the cost of small one dimensional changes to the viewPosition. Rather than repainting the entire viewport we use Graphics.copyArea to effect some of the scroll.

Parameters:: enabled - if true, maintain an offscreen backing store

setBorder

public final void setBorder(Border border)

The viewport "scrolls" its child (called the "view") by the normal parent/child clipping (typically the view is moved in the opposite direction of the scroll). A non-null border, or non-zero insets, isn't supported, to prevent the geometry of this component from becoming complex enough to inhibit subclassing. To create a JViewport with a border, add it to a JPanel that has a border.

Note: If border is non-null, this method will throw an exception as borders are not supported on a JViewPort.

Overrides:: setBorder in class JComponent
Parameters:: border - the Border to set

setExtentSize

public void setExtentSize(Dimension newExtent)

Sets the size of the visible part of the view using view coordinates.

Parameters:: newExtent - a Dimension object specifying the size of the view

setScrollMode

public void setScrollMode(int mode)

Used to control the method of scrolling the viewport contents. You may want to change this mode to get maximum performance for your use case.

Parameters:

mode - one of the following values:

JViewport.BLIT_SCROLL_MODE
JViewport.BACKINGSTORE_SCROLL_MODE
JViewport.SIMPLE_SCROLL_MODE

setUI

public void setUI(ViewportUI ui)

Sets the L&F object that renders this component.

Parameters:: ui - the ViewportUI L&F object

setView

public void setView(Component view)

Sets the JViewport's one lightweight child (view), which can be null.

Parameters:: view - the viewport's new lightweight child

setViewPosition

public void setViewPosition(Point p)

Sets the view coordinates that appear in the upper left hand corner of the viewport, does nothing if there's no view.

Parameters:: p - a Point object giving the upper left coordinates

setViewSize

public void setViewSize(Dimension newSize)

Sets the size of the view. A state changed event will be fired.

Parameters:: newSize - a Dimension object specifying the new size of the view

toViewCoordinates

public Dimension toViewCoordinates(Dimension size)

Converts a size in pixel coordinates to view coordinates. Subclasses of viewport that support "logical coordinates" will override this method.

Parameters:: size - a Dimension object using pixel coordinates
Returns:: a Dimension object converted to view coordinates

toViewCoordinates

public Point toViewCoordinates(Point p)

Converts a point in pixel coordinates to view coordinates. Subclasses of viewport that support "logical coordinates" will override this method.

Parameters:: p - a Point object using pixel coordinates
Returns:: a Point object converted to view coordinates

updateUI

public void updateUI()

Resets the UI property to a value from the current look and feel.

Overrides:: updateUI in class JComponent

Overview

Package

Class

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

This page displays the Jadeite version of the documention, which is derived from the offical documentation that contains this copyright notice:

The official Sun™ documentation can be found here at http://java.sun.com/javase/6/docs/api/.

javax.swingclass JViewport

backingStore

backingStoreImage

BACKINGSTORE_SCROLL_MODE

BLIT_SCROLL_MODE

isViewSizeSet

lastPaintPosition

scrollUnderway

SIMPLE_SCROLL_MODE

JViewport

addChangeListener

addImpl

computeBlit

createLayoutManager

createViewListener

firePropertyChange

fireStateChanged

getAccessibleContext

getChangeListeners

getExtentSize

getInsets

getInsets

getScrollMode

getUI

getUIClassID

getView

getViewPosition

getViewRect

getViewSize

isBackingStoreEnabled

isOptimizedDrawingEnabled

paint

paramString

remove

removeChangeListener

repaint

reshape

scrollRectToVisible

setBackingStoreEnabled

setBorder

setExtentSize

setScrollMode

setUI

setView

setViewPosition

setViewSize

toViewCoordinates

toViewCoordinates

updateUI

javax.swing
class JViewport