Class FSScrollPane

java.lang.Object

java.awt.Component

java.awt.Container

javax.swing.JComponent

javax.swing.JScrollPane

org.xhtmlrenderer.simple.FSScrollPane

All Implemented Interfaces:

ImageObserver, MenuContainer, Serializable, Accessible, ScrollPaneConstants

public class FSScrollPane
extends JScrollPane

FSScrollPane is a JScrollPane set up to support keyboard navigation of an XHTML/XML document rendered with Flying Saucer. In particular, it assigns key bindings to the view's InputMap for page-up, page-down, line-up/down, page-start and page-end. The amount the document scrolls is based on the current viewport and the current line height. If the view is resized, the scroll increment is automatically adjusted. Using FSScrollPane to display an XHTMLPanel should save you time as your users will have standard keyboard navigation out of the box.

To use FSScrollPane, just instantiate it and add your XHTMLPanel on instantiation:

XHTMLPanel panel = new XHTMLPanel();
FSScrollPane scroll = new FSScrollPane(view);

The current input mappings to keys are:

Scroll to Start

CONTROL-HOME or HOME

Scroll Up 1 Page

PAGEUP

Scroll Up 1 Line

UP-ARROW

Scroll to Bottom

CONTROL-END or END

Scroll Down 1 Page

PAGEDOWN

Scroll Down 1 Line

DOWN-ARROW

This class declares six constant strings you can use if you want to override one of these default settings on the InputMap; these Strings will be trigger the relevant Action associated with the scrolling. To change the key binding for "Scroll to Top" to Alt-Home, do this:

panel.getInputMap(JComponent.WHEN_IN_FOCUSED_WINDOW).
               put(KeyStroke.getKeyStroke(KeyEvent.VK_HOME, KeyEvent.ALT_MASK), FSScrollPane.PAGE_START);

See Also:

• Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class JScrollPane

JScrollPane.AccessibleJScrollPane, JScrollPane.ScrollBar

Nested classes/interfaces inherited from class JComponent

JComponent.AccessibleJComponent

Nested classes/interfaces inherited from class Container

Container.AccessibleAWTContainer

Nested classes/interfaces inherited from class Component

Component.AccessibleAWTComponent, Component.BaselineResizeBehavior, Component.BltBufferStrategy, Component.FlipBufferStrategy

Field Summary

Fields

Modifier and Type	Field	Description
static final String	LINE_DOWN	Constant used for mapping a key binding to "scroll down 1 line"
static final String	LINE_UP	Constant used for mapping a key binding to "scroll up 1 line"
static final String	PAGE_DOWN	Constant used for mapping a key binding to "scroll down 1 page"
static final String	PAGE_END	Constant used for mapping a key binding to "scroll to end of document"
static final String	PAGE_START	Constant used for mapping a key binding to "scroll to top of document"
static final String	PAGE_UP	Constant used for mapping a key binding to "scroll up 1 page"

Fields inherited from class JScrollPane

columnHeader, horizontalScrollBar, horizontalScrollBarPolicy, lowerLeft, lowerRight, rowHeader, upperLeft, upperRight, verticalScrollBar, verticalScrollBarPolicy, viewport

Fields inherited from class JComponent

listenerList, TOOL_TIP_TEXT_KEY, ui, UNDEFINED_CONDITION, WHEN_ANCESTOR_OF_FOCUSED_COMPONENT, WHEN_FOCUSED, WHEN_IN_FOCUSED_WINDOW

Fields inherited from class Component

accessibleContext, BOTTOM_ALIGNMENT, CENTER_ALIGNMENT, LEFT_ALIGNMENT, RIGHT_ALIGNMENT, TOP_ALIGNMENT

Fields inherited from interface ImageObserver

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

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

Constructor Summary

Constructors

Constructor	Description
FSScrollPane(JPanel view)	Instantiates a new FSScrollPane around the given Panel; see class documentation.

Method Summary

Modifier and Type	Method	Description
private void	addResizeListener(Component view)	Adds a component listener on the view for resize events, to adjust the scroll increment.
private void	setDefaultActionMap(JComponent view)	Assigns the default Actions for document navigation on the view.
private void	setDefaultInputMap(JComponent view)	Assigns the default keyboard bindings on the view for document navigation.
void	setViewportView(Component view)

Methods inherited from class JScrollPane

createHorizontalScrollBar, createVerticalScrollBar, createViewport, getAccessibleContext, getColumnHeader, getCorner, getHorizontalScrollBar, getHorizontalScrollBarPolicy, getRowHeader, getUI, getUIClassID, getVerticalScrollBar, getVerticalScrollBarPolicy, getViewport, getViewportBorder, getViewportBorderBounds, isValidateRoot, isWheelScrollingEnabled, paramString, setColumnHeader, setColumnHeaderView, setComponentOrientation, setCorner, setHorizontalScrollBar, setHorizontalScrollBarPolicy, setLayout, setRowHeader, setRowHeaderView, setUI, setVerticalScrollBar, setVerticalScrollBarPolicy, setViewport, setViewportBorder, setWheelScrollingEnabled, updateUI

Methods inherited from class 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, getInsets, getInsets, 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, isOptimizedDrawingEnabled, isPaintingForPrint, isPaintingOrigin, isPaintingTile, isRequestFocusEnabled, 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 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, transferFocusDownCycle, validate, validateTree

Methods inherited from class 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, 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, requestFocus, requestFocus, requestFocusInWindow, resize, resize, setBounds, setBounds, setCursor, setDropTarget, setFocusable, setFocusTraversalKeysEnabled, setIgnoreRepaint, setLocale, setLocation, setLocation, setMixingCutoutShape, setName, setSize, setSize, show, show, size, toString, transferFocus, transferFocusBackward, transferFocusUpCycle

Methods inherited from class Object

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

Field Details

PAGE_DOWN

public static final String PAGE_DOWN

Constant used for mapping a key binding to "scroll down 1 page"

See Also:

• Constant Field Values

PAGE_UP

public static final String PAGE_UP

Constant used for mapping a key binding to "scroll up 1 page"

See Also:

• Constant Field Values

LINE_DOWN

public static final String LINE_DOWN

Constant used for mapping a key binding to "scroll down 1 line"

See Also:

• Constant Field Values

LINE_UP

public static final String LINE_UP

Constant used for mapping a key binding to "scroll up 1 line"

See Also:

• Constant Field Values

PAGE_END

public static final String PAGE_END

Constant used for mapping a key binding to "scroll to end of document"

See Also:

• Constant Field Values

PAGE_START

public static final String PAGE_START

Constant used for mapping a key binding to "scroll to top of document"

See Also:

• Constant Field Values

Constructor Details

FSScrollPane

public FSScrollPane(JPanel view)

Instantiates a new FSScrollPane around the given Panel; see class documentation.

Method Details

setViewportView

public void setViewportView(Component view)

Overrides:

setViewportView in class JScrollPane

setDefaultInputMap

private void setDefaultInputMap(JComponent view)

Assigns the default keyboard bindings on the view for document navigation.

setDefaultActionMap

private void setDefaultActionMap(JComponent view)

Assigns the default Actions for document navigation on the view.

addResizeListener

private void addResizeListener(Component view)

Adds a component listener on the view for resize events, to adjust the scroll increment.