Class ContentPane

java.lang.Object

java.awt.Component

java.awt.Container

javax.swing.JComponent

javax.swing.JPanel

nl.siegmann.epublib.viewer.ContentPane

All Implemented Interfaces:

ImageObserver, MenuContainer, Serializable, EventListener, Accessible, HyperlinkListener, NavigationEventListener

public class ContentPane
extends JPanel
implements NavigationEventListener, HyperlinkListener

Displays a page

See Also:

• Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class JPanel

JPanel.AccessibleJPanel

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
private Resource	currentResource
private JEditorPane	editorPane
private HTMLDocumentFactory	htmlDocumentFactory
private static final org.slf4j.Logger	log
private Navigator	navigator
private JScrollPane	scrollPane
private static final long	serialVersionUID

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

Constructor Summary

Constructors

Constructor	Description
ContentPane(Navigator navigator)

Method Summary

Modifier and Type	Method	Description
private String	calculateTargetHref(URL clickUrl)	Transforms a link generated by a click on a link in a document to a resource href.
private JEditorPane	createJEditorPane()
void	displayPage(Resource resource)
void	displayPage(Resource resource, int sectionPos)
void	gotoNextPage()
void	gotoPreviousPage()
void	hyperlinkUpdate(HyperlinkEvent event)
private void	initBook(Book book)
private static boolean	matchesAny(String searchString, String... possibleValues)	Whether the given searchString matches any of the possibleValues.
void	navigationPerformed(NavigationEvent navigationEvent)	Called whenever the user navigates to another position in the book.
private void	scrollToCurrentPosition(int sectionPos)
private static void	scrollToElement(JEditorPane editorPane, HTMLDocument.Iterator elementIterator)	Scrolls the editorPane to the startOffset of the current element in the elementIterator
private void	scrollToNamedAnchor(String fragmentId)	Scrolls the editorPane to the first anchor element whose id or name matches the given fragmentId.

Methods inherited from class JPanel

getAccessibleContext, getUI, getUIClassID, paramString, setUI, 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, 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 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, 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, setComponentOrientation, 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

serialVersionUID

private static final long serialVersionUID

See Also:

• Constant Field Values

log

private static final org.slf4j.Logger log

navigator

private Navigator navigator

currentResource

private Resource currentResource

editorPane

private JEditorPane editorPane

scrollPane

private JScrollPane scrollPane

htmlDocumentFactory

private HTMLDocumentFactory htmlDocumentFactory

Constructor Details

ContentPane

public ContentPane(Navigator navigator)

Method Details

initBook

private void initBook(Book book)

matchesAny

private static boolean matchesAny(String searchString,
 String... possibleValues)

Whether the given searchString matches any of the possibleValues.

Parameters:

searchString -

possibleValues -

Returns:

Whether the given searchString matches any of the possibleValues.

scrollToElement

private static void scrollToElement(JEditorPane editorPane,
 HTMLDocument.Iterator elementIterator)

Scrolls the editorPane to the startOffset of the current element in the elementIterator

Parameters:

editorPane -

elementIterator -

requestFragmentId -

attributeValue -

scrollToNamedAnchor

private void scrollToNamedAnchor(String fragmentId)

Scrolls the editorPane to the first anchor element whose id or name matches the given fragmentId.

Parameters:

fragmentId -

createJEditorPane

private JEditorPane createJEditorPane()

displayPage

public void displayPage(Resource resource)

displayPage

public void displayPage(Resource resource,
 int sectionPos)

scrollToCurrentPosition

private void scrollToCurrentPosition(int sectionPos)

hyperlinkUpdate

public void hyperlinkUpdate(HyperlinkEvent event)

Specified by:

hyperlinkUpdate in interface HyperlinkListener

gotoPreviousPage

public void gotoPreviousPage()

gotoNextPage

public void gotoNextPage()

calculateTargetHref

private String calculateTargetHref(URL clickUrl)

Transforms a link generated by a click on a link in a document to a resource href. Property handles http encoded spaces and such.

Parameters:

clickUrl -

Returns:

a link generated by a click on a link transformed into a document to a resource href.

navigationPerformed

public void navigationPerformed(NavigationEvent navigationEvent)

Description copied from interface: NavigationEventListener

Called whenever the user navigates to another position in the book.

Specified by:

navigationPerformed in interface NavigationEventListener

Parameters:

navigationEvent -