Class ScrollablePicture

java.lang.Object
  java.awt.Component
      java.awt.Container
          javax.swing.JComponent
              javax.swing.JLabel
                  ScrollablePicture

All Implemented Interfaces:

java.awt.image.ImageObserver, java.awt.MenuContainer, java.io.Serializable, javax.accessibility.Accessible, javax.swing.Scrollable, javax.swing.SwingConstants

public class ScrollablePicture
extends javax.swing.JLabel
implements javax.swing.Scrollable

ScrollablePicture extends JLabel and uses the Scrollable interface. ScrollablePicture the picture being scrolled on. It is the full image, but only a portion will be shown on the display, depending on the size of the cnavas. There are currently no OS dependencies or variations. There are no security constraints and no external references.

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class javax.swing.JLabel

javax.swing.JLabel.AccessibleJLabel

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

javax.swing.JComponent.AccessibleJComponent

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

java.awt.Container.AccessibleAWTContainer

Nested classes/interfaces inherited from class java.awt.Component

java.awt.Component.AccessibleAWTComponent, java.awt.Component.BltBufferStrategy, java.awt.Component.FlipBufferStrategy

Field Summary

int	maxUnitIncrement The size of scrolling increment There are no OS/Hardware dependencies and no variances.

Fields inherited from class javax.swing.JLabel

labelFor

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

Fields inherited from interface javax.swing.SwingConstants

BOTTOM, CENTER, EAST, HORIZONTAL, LEADING, LEFT, NEXT, NORTH, NORTH_EAST, NORTH_WEST, PREVIOUS, RIGHT, SOUTH, SOUTH_EAST, SOUTH_WEST, TOP, TRAILING, VERTICAL, WEST

Fields inherited from interface java.awt.image.ImageObserver

ABORT, ALLBITS, ERROR, FRAMEBITS, HEIGHT, PROPERTIES, SOMEBITS, WIDTH

Constructor Summary

ScrollablePicture(javax.swing.ImageIcon i, int m)
Constructor that initializes the image icon and the maximum unit number of scrolling increment.

Method Summary

int	getMaxUnitIncrement() Returns the value of maxUnitIncrement.
java.awt.Dimension	getPreferredScrollableViewportSize() Returns the default preferred size as determined by the layout manager.
int	getScrollableBlockIncrement(java.awt.Rectangle visibleRect, int orientation, int direction) Returns the width-maxUnitIncrement or height-maxUnitIncrement according to orientation.
boolean	getScrollableTracksViewportHeight() Returns false any time this method is called.
boolean	getScrollableTracksViewportWidth() Returns false any time this method is called.
int	getScrollableUnitIncrement(java.awt.Rectangle visibleRect, int orientation, int direction) Returns the amount by which the picture can be scrolled in pixels, given direction.
void	setMaxUnitIncrement(int pixels) Sets maxUnitIncrement to the paramater passed.

Methods inherited from class javax.swing.JLabel

checkHorizontalKey, checkVerticalKey, getAccessibleContext, getDisabledIcon, getDisplayedMnemonic, getDisplayedMnemonicIndex, getHorizontalAlignment, getHorizontalTextPosition, getIcon, getIconTextGap, getLabelFor, getText, getUI, getUIClassID, getVerticalAlignment, getVerticalTextPosition, imageUpdate, paramString, setDisabledIcon, setDisplayedMnemonic, setDisplayedMnemonic, setDisplayedMnemonicIndex, setHorizontalAlignment, setHorizontalTextPosition, setIcon, setIconTextGap, setLabelFor, setText, setUI, setVerticalAlignment, setVerticalTextPosition, updateUI

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, 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, getVerifyInputWhenFocusTarget, getVetoableChangeListeners, getVisibleRect, getWidth, getX, getY, grabFocus, isDoubleBuffered, isLightweightComponent, isManagingFocus, isOpaque, isOptimizedDrawingEnabled, isPaintingTile, isRequestFocusEnabled, isValidateRoot, paint, paintBorder, paintChildren, paintComponent, paintImmediately, paintImmediately, 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

Methods inherited from class java.awt.Container

add, add, add, add, add, addContainerListener, addImpl, 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, remove, removeAll, removeContainerListener, setComponentZOrder, setFocusCycleRoot, setFocusTraversalPolicy, setFocusTraversalPolicyProvider, setLayout, transferFocusBackward, 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, 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, hide, 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, transferFocusUpCycle

Methods inherited from class java.lang.Object

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

Field Detail

maxUnitIncrement

public int maxUnitIncrement

The size of scrolling increment There are no OS/Hardware dependencies and no variances. There is no need for any security constraints and no references to external specifications.

Constructor Detail

ScrollablePicture

public ScrollablePicture(javax.swing.ImageIcon i,
                         int m)

Constructor that initializes the image icon and the maximum unit number of scrolling increment. There are no OS/Hardware dependencies and no variances. There is no need for any security constraints and no references to external specifications.

Parameters:

i - Image to be scrolled

m - The amount of increment of scrolling unit

Method Detail

getPreferredScrollableViewportSize

public java.awt.Dimension getPreferredScrollableViewportSize()

Returns the default preferred size as determined by the layout manager. There are no OS/Hardware dependencies and no variances. There is no need for any security constraints and no references to external specifications.

Specified by:

getPreferredScrollableViewportSize in interface javax.swing.Scrollable

Returns:

Dimension that described the preferred size

getScrollableUnitIncrement

public int getScrollableUnitIncrement(java.awt.Rectangle visibleRect,
                                      int orientation,
                                      int direction)

Returns the amount by which the picture can be scrolled in pixels, given direction. Calculates scrollable distance including when the canvas cannot be scrolled the maxUnitIncrement due to current scroll position. There are no OS/Hardware dependencies and no variances. There is no need for any security constraints and no references to external specifications.

Specified by:

getScrollableUnitIncrement in interface javax.swing.Scrollable

Parameters:

visibleRect - Rectangle which is the portion in display

orientation - Integer that represents either horizontal or vertical

direction - Integer that represents either positive or negative scroll

Returns:

integer distance of scroll

getScrollableBlockIncrement

public int getScrollableBlockIncrement(java.awt.Rectangle visibleRect,
                                       int orientation,
                                       int direction)

Returns the width-maxUnitIncrement or height-maxUnitIncrement according to orientation. There are no OS/Hardware dependencies and no variances. There is no need for any security constraints and no references to external specifications.

Specified by:

getScrollableBlockIncrement in interface javax.swing.Scrollable

Parameters:

visibleRect - Rectangle that represents either portion in the display

orientation - Integer that represents either horizontal or vertical

direction - Integer that represents either positive or negative scroll

Returns:

width or height - maxUnitIncrement

getScrollableTracksViewportWidth

public boolean getScrollableTracksViewportWidth()

Returns false any time this method is called. There are no OS/Hardware dependencies and no variances. There is no need for any security constraints and no references to external specifications.

Specified by:

getScrollableTracksViewportWidth in interface javax.swing.Scrollable

Returns:

false

getScrollableTracksViewportHeight

public boolean getScrollableTracksViewportHeight()

Returns false any time this method is called. There are no OS/Hardware dependencies and no variances. There is no need for any security constraints and no references to external specifications.

Specified by:

getScrollableTracksViewportHeight in interface javax.swing.Scrollable

Returns:

false

setMaxUnitIncrement

public void setMaxUnitIncrement(int pixels)

Sets maxUnitIncrement to the paramater passed. There are no OS/Hardware dependencies and no variances. There is no need for any security constraints and no references to external specifications.

Parameters:

pixels - Integer to set maxUnitIncrement

See Also:

getMaxUnitIncrement()

getMaxUnitIncrement

public int getMaxUnitIncrement()

Returns the value of maxUnitIncrement. There are no OS/Hardware dependencies and no variances. There is no need for any security constraints and no references to external specifications.

Returns:

maxUnitIncrement The size of maxUnitIncrement value

See Also:

setMaxUnitIncrement(int)