- java.lang.Object
-
- java.awt.Component
-
- java.awt.Container
-
- javax.swing.JComponent
-
- javax.swing.JViewport
-
- All Implemented Interfaces:
- ImageObserver, MenuContainer, Serializable, Accessible
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,
JViewportis opaque. To change this, use thesetOpaquemethod.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 acopyAreaon 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.
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 JavaBeansTM has been added to the
java.beanspackage. Please seeXMLEncoder.- See Also:
JScrollPane
-
-
Nested Class Summary
Nested Classes Modifier and Type Class and Description protected classJViewport.AccessibleJViewportThis class implements accessibility support for theJViewportclass.protected classJViewport.ViewListenerA 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
Fields Modifier and Type Field and Description protected booleanbackingStoreDeprecated.As of Java 2 platform v1.3static intBACKINGSTORE_SCROLL_MODEDraws viewport contents into an offscreen image.protected ImagebackingStoreImageThe view image used for a backing store.static intBLIT_SCROLL_MODEUsegraphics.copyAreato implement scrolling.protected booleanisViewSizeSetTrue when the viewport dimensions have been determined.protected PointlastPaintPositionThe lastviewPositionthat we've painted, so we know how much of the backing store image is valid.protected booleanscrollUnderwayThescrollUnderwayflag is used for components likeJList.static intSIMPLE_SCROLL_MODEThis 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
Constructors Constructor and Description JViewport()Creates aJViewport.
-
Method Summary
Methods Modifier and Type Method and Description voidaddChangeListener(ChangeListener l)Adds aChangeListenerto the list that is notified each time the view's size, position, or the viewport's extent size has changed.protected voidaddImpl(Component child, Object constraints, int index)Sets theJViewport's one lightweight child, which can benull.protected booleancomputeBlit(int dx, int dy, Point blitFrom, Point blitTo, Dimension blitSize, Rectangle blitPaint)Computes the parameters for a blit where the backing store image currently containsoldLocin the upper left hand corner and we're scrolling tonewLoc.protected LayoutManagercreateLayoutManager()Subclassers can override this to install a different layout manager (ornull) in the constructor.protected JViewport.ViewListenercreateViewListener()Creates a listener for the view.protected voidfirePropertyChange(String propertyName, Object oldValue, Object newValue)Notifies listeners of a property change.protected voidfireStateChanged()Notifies allChangeListenerswhen the views size, position, or the viewports extent size has changed.AccessibleContextgetAccessibleContext()Gets the AccessibleContext associated with this JViewport.ChangeListener[]getChangeListeners()Returns an array of all theChangeListeners added to this JViewport with addChangeListener().DimensiongetExtentSize()Returns the size of the visible part of the view in view coordinates.InsetsgetInsets()Returns the insets (border) dimensions as (0,0,0,0), since borders are not supported on aJViewport.InsetsgetInsets(Insets insets)Returns anInsetsobject containing thisJViewports inset values.intgetScrollMode()Returns the current scrolling mode.ViewportUIgetUI()Returns the L&F object that renders this component.StringgetUIClassID()Returns a string that specifies the name of the L&F class that renders this component.ComponentgetView()Returns theJViewport's one child ornull.PointgetViewPosition()Returns the view coordinates that appear in the upper left hand corner of the viewport, or 0,0 if there's no view.RectanglegetViewRect()Returns a rectangle whose origin isgetViewPositionand size isgetExtentSize.DimensiongetViewSize()If the view's size hasn't been explicitly set, return the preferred size, otherwise return the view's current size.booleanisBackingStoreEnabled()Deprecated.As of Java 2 platform v1.3, replaced bygetScrollMode().booleanisOptimizedDrawingEnabled()TheJViewportoverrides the default implementation of this method (inJComponent) to return false.protected booleanisPaintingOrigin()Returns true if scroll mode is aBACKINGSTORE_SCROLL_MODEto cause painting to originate fromJViewport, or one of its ancestors.voidpaint(Graphics g)Depending on whether thebackingStoreis 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 StringparamString()Returns a string representation of thisJViewport.voidremove(Component child)Removes theViewports one lightweight child.voidremoveChangeListener(ChangeListener l)Removes aChangeListenerfrom the list that's notified each time the views size, position, or the viewports extent size has changed.voidrepaint(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 theRepaintManager.voidreshape(int x, int y, int w, int h)Sets the bounds of this viewport.voidscrollRectToVisible(Rectangle contentRect)Scrolls the view so thatRectanglewithin the view becomes visible.voidsetBackingStoreEnabled(boolean enabled)Deprecated.As of Java 2 platform v1.3, replaced bysetScrollMode().voidsetBorder(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).voidsetExtentSize(Dimension newExtent)Sets the size of the visible part of the view using view coordinates.voidsetScrollMode(int mode)Used to control the method of scrolling the viewport contents.voidsetUI(ViewportUI ui)Sets the L&F object that renders this component.voidsetView(Component view)Sets theJViewport's one lightweight child (view), which can benull.voidsetViewPosition(Point p)Sets the view coordinates that appear in the upper left hand corner of the viewport, does nothing if there's no view.voidsetViewSize(Dimension newSize)Sets the size of the view.DimensiontoViewCoordinates(Dimension size)Converts a size in pixel coordinates to view coordinates.PointtoViewCoordinates(Point p)Converts a point in pixel coordinates to view coordinates.voidupdateUI()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, getActionForKeyStroke, getActionMap, getAlignmentX, getAlignmentY, getAncestorListeners, getAutoscrolls, getBaseline, getBaselineResizeBehavior, getBorder, getBounds, getClientProperty, getComponentGraphics, getComponentPopupMenu, getConditionForKeyStroke, getDebugGraphicsOptions, getDefaultLocale, getFontMetrics, getGraphics, getHeight, getInheritsPopupMenu, getInputMap, getInputMap, getInputVerifier, getListeners, getLocation, getMaximumSize, getMinimumSize, getNextFocusableComponent, getPopupLocation, getPreferredSize, getRegisteredKeyStrokes, getRootPane, getSize, getToolTipLocation, getToolTipText, getToolTipText, getTopLevelAncestor, getTransferHandler, getVerifyInputWhenFocusTarget, getVetoableChangeListeners, getVisibleRect, getWidth, getX, getY, grabFocus, hide, isDoubleBuffered, isLightweightComponent, isManagingFocus, isOpaque, isPaintingForPrint, isPaintingTile, isRequestFocusEnabled, isValidateRoot, paintBorder, paintChildren, paintComponent, paintImmediately, paintImmediately, print, printAll, printBorder, printChildren, printComponent, processComponentKeyEvent, processKeyBinding, processKeyEvent, processMouseEvent, processMouseMotionEvent, putClientProperty, registerKeyboardAction, registerKeyboardAction, removeAncestorListener, removeNotify, removeVetoableChangeListener, repaint, requestDefaultFocus, requestFocus, requestFocus, requestFocusInWindow, requestFocusInWindow, resetKeyboardActions, revalidate, setActionMap, setAlignmentX, setAlignmentY, setAutoscrolls, setBackground, setComponentPopupMenu, setDebugGraphicsOptions, setDefaultLocale, setDoubleBuffered, setEnabled, setFocusTraversalKeys, setFont, setForeground, setInheritsPopupMenu, setInputMap, setInputVerifier, setMaximumSize, setMinimumSize, setNextFocusableComponent, setOpaque, setPreferredSize, setRequestFocusEnabled, setToolTipText, setTransferHandler, setUI, setVerifyInputWhenFocusTarget, setVisible, unregisterKeyboardAction, update
-
Methods inherited from class java.awt.Container
add, add, add, add, add, addContainerListener, addPropertyChangeListener, addPropertyChangeListener, applyComponentOrientation, areFocusTraversalKeysSet, countComponents, deliverEvent, doLayout, findComponentAt, findComponentAt, getComponent, getComponentAt, getComponentAt, getComponentCount, getComponents, getComponentZOrder, getContainerListeners, getFocusTraversalKeys, getFocusTraversalPolicy, getLayout, getMousePosition, insets, invalidate, isAncestorOf, isFocusCycleRoot, isFocusCycleRoot, isFocusTraversalPolicyProvider, isFocusTraversalPolicySet, layout, list, list, locate, minimumSize, paintComponents, preferredSize, printComponents, processContainerEvent, processEvent, remove, removeAll, removeContainerListener, setComponentZOrder, setFocusCycleRoot, setFocusTraversalPolicy, setFocusTraversalPolicyProvider, setLayout, transferFocusDownCycle, validate, validateTree
-
Methods inherited from class java.awt.Component
action, add, addComponentListener, addFocusListener, addHierarchyBoundsListener, addHierarchyListener, addInputMethodListener, addKeyListener, addMouseListener, addMouseMotionListener, addMouseWheelListener, bounds, checkImage, checkImage, coalesceEvents, contains, createImage, createImage, createVolatileImage, createVolatileImage, disableEvents, dispatchEvent, enable, enableEvents, enableInputMethods, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, getBackground, getBounds, getColorModel, getComponentListeners, getComponentOrientation, getCursor, getDropTarget, getFocusCycleRootAncestor, getFocusListeners, getFocusTraversalKeysEnabled, getFont, getForeground, getGraphicsConfiguration, getHierarchyBoundsListeners, getHierarchyListeners, getIgnoreRepaint, getInputContext, getInputMethodListeners, getInputMethodRequests, getKeyListeners, getLocale, getLocation, getLocationOnScreen, getMouseListeners, getMouseMotionListeners, getMousePosition, getMouseWheelListeners, getName, getParent, getPeer, getPropertyChangeListeners, getPropertyChangeListeners, getSize, getToolkit, getTreeLock, gotFocus, handleEvent, hasFocus, imageUpdate, inside, isBackgroundSet, isCursorSet, isDisplayable, isEnabled, isFocusable, isFocusOwner, isFocusTraversable, isFontSet, isForegroundSet, isLightweight, isMaximumSizeSet, isMinimumSizeSet, isPreferredSizeSet, isShowing, isValid, isVisible, keyDown, keyUp, list, list, list, location, lostFocus, mouseDown, mouseDrag, mouseEnter, mouseExit, mouseMove, mouseUp, move, nextFocus, paintAll, postEvent, prepareImage, prepareImage, processComponentEvent, processFocusEvent, processHierarchyBoundsEvent, processHierarchyEvent, processInputMethodEvent, processMouseWheelEvent, remove, removeComponentListener, removeFocusListener, removeHierarchyBoundsListener, removeHierarchyListener, removeInputMethodListener, removeKeyListener, removeMouseListener, removeMouseMotionListener, removeMouseWheelListener, removePropertyChangeListener, removePropertyChangeListener, repaint, repaint, repaint, resize, resize, setBounds, setBounds, setComponentOrientation, setCursor, setDropTarget, setFocusable, setFocusTraversalKeysEnabled, setIgnoreRepaint, setLocale, setLocation, setLocation, setName, setSize, setSize, show, show, size, toString, transferFocus, transferFocusBackward, transferFocusUpCycle
-
-
-
-
Field Detail
-
isViewSizeSet
protected boolean isViewSizeSet
True when the viewport dimensions have been determined. The default is false.
-
lastPaintPosition
protected Point lastPaintPosition
The lastviewPositionthat we've painted, so we know how much of the backing store image is valid.
-
backingStore
@Deprecated protected boolean backingStore
Deprecated. As of Java 2 platform v1.3True 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 isfalse.- See Also:
setScrollMode(int)
-
backingStoreImage
protected transient Image backingStoreImage
The view image used for a backing store.
-
scrollUnderway
protected boolean scrollUnderway
ThescrollUnderwayflag is used for components likeJList. When the downarrow key is pressed on aJListand the selected cell is the last in the list, thescrollpaneautoscrolls. 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 tosetViewPosition(Point). WhensetBoundsis called through other routes, the flag is off and the view repaints normally. Another approach would be to remove this from theJViewportclass and have theJListmanage this case by usingsetBackingStoreEnabled. The default isfalse.
-
BLIT_SCROLL_MODE
public static final int BLIT_SCROLL_MODE
Usegraphics.copyAreato implement scrolling. This is the fastest for most applications.- Since:
- 1.3
- See Also:
setScrollMode(int), Constant Field Values
-
BACKINGSTORE_SCROLL_MODE
public static final int BACKINGSTORE_SCROLL_MODE
Draws viewport contents into an offscreen image. This was previously the default mode forJTable. This mode may offer advantages over "blit mode" in some cases, but it requires a large chunk of extra RAM.- Since:
- 1.3
- See Also:
setScrollMode(int), Constant Field Values
-
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.- Since:
- 1.3
- See Also:
setScrollMode(int), Constant Field Values
-
-
Method Detail
-
getUI
public ViewportUI getUI()
Returns the L&F object that renders this component.- Returns:
- a
ViewportUIobject - Since:
- 1.3
-
setUI
public void setUI(ViewportUI ui)
Sets the L&F object that renders this component.- Parameters:
ui- theViewportUIL&F object- Since:
- 1.3
- See Also:
UIDefaults.getUI(javax.swing.JComponent)
-
updateUI
public void updateUI()
Resets the UI property to a value from the current look and feel.- Overrides:
updateUIin classJComponent- See Also:
JComponent.updateUI()
-
getUIClassID
public String getUIClassID()
Returns a string that specifies the name of the L&F class that renders this component.- Overrides:
getUIClassIDin classJComponent- Returns:
- the string "ViewportUI"
- See Also:
JComponent.getUIClassID(),UIDefaults.getUI(javax.swing.JComponent)
-
addImpl
protected void addImpl(Component child, Object constraints, int index)
Sets theJViewport's one lightweight child, which can benull. (Since there is only one child which occupies the entire viewport, theconstraintsandindexarguments are ignored.)- Overrides:
addImplin classContainer- Parameters:
child- the lightweightchildof the viewportconstraints- theconstraintsto be respectedindex- the index- See Also:
setView(java.awt.Component)
-
remove
public void remove(Component child)
Removes theViewports one lightweight child.- Overrides:
removein classContainer- Parameters:
child- the component to be removed- See Also:
setView(java.awt.Component)
-
scrollRectToVisible
public void scrollRectToVisible(Rectangle contentRect)
Scrolls the view so thatRectanglewithin the view becomes visible.This attempts to validate the view before scrolling if the view is currently not valid -
isValidreturns 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 aWindoworApplet.Note that this method will not scroll outside of the valid viewport; for example, if
contentRectis larger than the viewport, scrolling will be confined to the viewport's bounds.- Overrides:
scrollRectToVisiblein classJComponent- Parameters:
contentRect- theRectangleto display- See Also:
JComponent.isValidateRoot(),Component.isValid(),Component.getPeer()
-
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-nullborder, or non-zero insets, isn't supported, to prevent the geometry of this component from becoming complex enough to inhibit subclassing. To create aJViewportwith a border, add it to aJPanelthat has a border.Note: If
borderis non-null, this method will throw an exception as borders are not supported on aJViewPort.- Overrides:
setBorderin classJComponent- Parameters:
border- theBorderto set- Throws:
IllegalArgumentException- this method is not implemented- See Also:
Border,CompoundBorder
-
getInsets
public final Insets getInsets()
Returns the insets (border) dimensions as (0,0,0,0), since borders are not supported on aJViewport.- Overrides:
getInsetsin classJComponent- Returns:
- a
Rectangeof zero dimension and zero origin - See Also:
setBorder(javax.swing.border.Border)
-
getInsets
public final Insets getInsets(Insets insets)
Returns anInsetsobject containing thisJViewports inset values. The passed-inInsetsobject will be reinitialized, and all existing values within this object are overwritten.- Overrides:
getInsetsin classJComponent- Parameters:
insets- theInsetsobject which can be reused- Returns:
- this viewports inset values
- See Also:
getInsets()
-
isOptimizedDrawingEnabled
public boolean isOptimizedDrawingEnabled()
TheJViewportoverrides the default implementation of this method (inJComponent) to return false. This ensures that the drawing machinery will call theViewport'spaintimplementation rather than messaging theJViewport's children directly.- Overrides:
isOptimizedDrawingEnabledin classJComponent- Returns:
- false
-
isPaintingOrigin
protected boolean isPaintingOrigin()
Returns true if scroll mode is aBACKINGSTORE_SCROLL_MODEto cause painting to originate fromJViewport, or one of its ancestors. Otherwise returnsfalse.- Overrides:
isPaintingOriginin classJComponent- Returns:
- true if if scroll mode is a
BACKINGSTORE_SCROLL_MODE. - See Also:
JComponent.isPaintingOrigin()
-
paint
public void paint(Graphics g)
Depending on whether thebackingStoreis 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:
paintin classJComponent- Parameters:
g- theGraphicscontext within which to paint- See Also:
JComponent.paintComponent(java.awt.Graphics),JComponent.paintBorder(java.awt.Graphics),JComponent.paintChildren(java.awt.Graphics),JComponent.getComponentGraphics(java.awt.Graphics),JComponent.repaint(long, int, int, int, int)
-
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 aStateChangedevent.- Overrides:
reshapein classJComponent- Parameters:
x- left edge of the originy- top edge of the originw- width in pixelsh- height in pixels- See Also:
JComponent.reshape(int, int, int, int)
-
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
- Since:
- 1.3
- See Also:
BLIT_SCROLL_MODE,BACKINGSTORE_SCROLL_MODE,SIMPLE_SCROLL_MODE
-
getScrollMode
public int getScrollMode()
Returns the current scrolling mode.- Returns:
- the
scrollModeproperty - Since:
- 1.3
- See Also:
setScrollMode(int)
-
isBackingStoreEnabled
@Deprecated public boolean isBackingStoreEnabled()
Deprecated. As of Java 2 platform v1.3, replaced bygetScrollMode().Returnstrueif this viewport is maintaining an offscreen image of its contents.- Returns:
trueifscrollModeisBACKINGSTORE_SCROLL_MODE
-
setBackingStoreEnabled
@Deprecated public void setBackingStoreEnabled(boolean enabled)
Deprecated. As of Java 2 platform v1.3, replaced bysetScrollMode().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 theviewPosition. Rather than repainting the entire viewport we useGraphics.copyAreato effect some of the scroll.- Parameters:
enabled- if true, maintain an offscreen backing store
-
getView
public Component getView()
Returns theJViewport's one child ornull.- Returns:
- the viewports child, or
nullif none exists - See Also:
setView(java.awt.Component)
-
setView
public void setView(Component view)
Sets theJViewport's one lightweight child (view), which can benull.- Parameters:
view- the viewport's new lightweight child- See Also:
getView()
-
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
Dimensionobject specifying the size of the view
-
setViewSize
public void setViewSize(Dimension newSize)
Sets the size of the view. A state changed event will be fired.- Parameters:
newSize- aDimensionobject specifying the new size of the view
-
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
Pointobject giving the upper left coordinates
-
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- aPointobject giving the upper left coordinates
-
getViewRect
public Rectangle getViewRect()
Returns a rectangle whose origin isgetViewPositionand size isgetExtentSize. This is the visible part of the view, in view coordinates.- Returns:
- a
Rectanglegiving the visible part of the view using view coordinates.
-
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 containsoldLocin the upper left hand corner and we're scrolling tonewLoc. The parameters are modified to return the values required for the blit.- Parameters:
dx- the horizontal deltady- the vertical deltablitFrom- thePointwe're blitting fromblitTo- thePointwe're blitting toblitSize- theDimensionof the area to blitblitPaint- the area to blit- Returns:
- true if the parameters are modified and we're ready to blit; false otherwise
-
getExtentSize
public Dimension getExtentSize()
Returns the size of the visible part of the view in view coordinates.- Returns:
- a
Dimensionobject giving the 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- aDimensionobject using pixel coordinates- Returns:
- a
Dimensionobject 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- aPointobject using pixel coordinates- Returns:
- a
Pointobject converted to view coordinates
-
setExtentSize
public void setExtentSize(Dimension newExtent)
Sets the size of the visible part of the view using view coordinates.- Parameters:
newExtent- aDimensionobject specifying the size of the view
-
createViewListener
protected JViewport.ViewListener createViewListener()
Creates a listener for the view.- Returns:
- a
ViewListener
-
createLayoutManager
protected LayoutManager createLayoutManager()
Subclassers can override this to install a different layout manager (ornull) in the constructor. Returns theLayoutManagerto install on theJViewport.- Returns:
- a
LayoutManager
-
addChangeListener
public void addChangeListener(ChangeListener l)
Adds aChangeListenerto the list that is notified each time the view's size, position, or the viewport's extent size has changed.- Parameters:
l- theChangeListenerto add- See Also:
removeChangeListener(javax.swing.event.ChangeListener),setViewPosition(java.awt.Point),setViewSize(java.awt.Dimension),setExtentSize(java.awt.Dimension)
-
removeChangeListener
public void removeChangeListener(ChangeListener l)
Removes aChangeListenerfrom the list that's notified each time the views size, position, or the viewports extent size has changed.- Parameters:
l- theChangeListenerto remove- See Also:
addChangeListener(javax.swing.event.ChangeListener)
-
getChangeListeners
public ChangeListener[] getChangeListeners()
Returns an array of all theChangeListeners added to this JViewport with addChangeListener().- Returns:
- all of the
ChangeListeners added or an empty array if no listeners have been added - Since:
- 1.4
-
fireStateChanged
protected void fireStateChanged()
Notifies allChangeListenerswhen the views size, position, or the viewports extent size has changed.
-
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 theRepaintManager.- Overrides:
repaintin classJComponent- Parameters:
tm- maximum time in milliseconds before updatex- thexcoordinate (pixels over from left)y- theycoordinate (pixels down from top)w- the widthh- the height- See Also:
Component.update(java.awt.Graphics)
-
paramString
protected String paramString()
Returns a string representation of thisJViewport. 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 benull.- Overrides:
paramStringin classJComponent- Returns:
- a string representation of this
JViewport
-
firePropertyChange
protected void firePropertyChange(String propertyName, Object oldValue, Object newValue)
Notifies listeners of a property change. This is subclassed to update thewindowBlitproperty. (TheputClientPropertyproperty is final).- Overrides:
firePropertyChangein classComponent- Parameters:
propertyName- a string containing the property nameoldValue- the old value of the propertynewValue- the new value of the property
-
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.- Specified by:
getAccessibleContextin interfaceAccessible- Overrides:
getAccessibleContextin classJComponent- Returns:
- an AccessibleJViewport that serves as the AccessibleContext of this JViewport
-
-
Traduction non disponible
Les API Java ne sont pas encore traduites en français sur l'infobrol. Seule la version anglaise est disponible pour l'instant.
Version en cache
09/10/2025 12:09:19 Cette version de la page est en cache (à la date du 09/10/2025 12:09:19) afin d'accélérer le traitement.Vous pouvez activer le mode utilisateur dans le menu en haut pour afficher la version plus récente de la page.
Document créé le 16/09/2006, dernière modification le 04/03/2020
Source du document imprimé : https://www.gaudry.be/java-api-rf-javax/swing/jviewport.html
L'infobrol est un site personnel dont le contenu n'engage que moi. Le texte est mis à disposition sous licence CreativeCommons(BY-NC-SA). Plus d'info sur les conditions d'utilisation et sur l'auteur.
Références
Ces références et liens indiquent des documents consultés lors de la rédaction de cette page, ou qui peuvent apporter un complément d'information, mais les auteurs de ces sources ne peuvent être tenus responsables du contenu de cette page.
L'auteur de ce site est seul responsable de la manière dont sont présentés ici les différents concepts, et des libertés qui sont prises avec les ouvrages de référence. N'oubliez pas que vous devez croiser les informations de sources multiples afin de diminuer les risques d'erreurs.