com.levigo.jadice.swing.navigator
Class NavigatorComponent

java.lang.Object
  java.awt.Component
      java.awt.Container
          javax.swing.JComponent
              com.levigo.jadice.swing.navigator.NavigatorComponent

All Implemented Interfaces:

ImageObserver, MenuContainer, Serializable

public class NavigatorComponent
extends JComponent

A navigator component provides a thumbnail view of the PageViews current page. Above the thumbnail a visual rectangle is displayed to show the current visibility area of the page within the PageView.

The UI-Properties used by this component are

UI-Properties

Property	Type	Description	Default value
NavigatorComponent.background	Color	The color of the background	Same as 'ThumbnailView.background'
NavigatorComponent.foreground	Color	The color of foreground elements like labels etc.	Same as 'ThumbnailView.foreground'
NavigatorComponent.border	Border	The border of this view	Same as 'Panel.border'
NavigatorComponent.visibleBoundsBorder	Border	The border used to designate the area visible in an associated PageView	Red frame with semi-transparent inner frame. Same as 'ThumbnailView.visibleBoundsBorder'
NavigatorComponent.font	Font	The font used to render labels etc.	Same as 'Thumbnail.font'
NavigatorComponent.thumbnailSize	Dimension	The default thumb nail size.	Dimension(200,200)
NavigatorComponent.lockIcon	Icon	an icon indicating whether the navigator applies the page view render settings or not	"/com/levigo/jadice/swing/resources/jadice-viewer.TB_NAVIGATOR_LOCK
NavigatorComponent.focusInputMap	InputMap	The input map	See section 'Input Map'

The default Input Map used by this component

Input map

Key	Action Name
HOME	navigateHOME
END	navigateEND
UP	navigateUP
KP_UP	navigateUP
PAGE_UP	navigateUP
LEFT	navigateUP
KP_LEFT	navigateUP
RIGHT	navigateDOWN
KP_RIGHT	navigateDOWN
DOWN	navigateDOWN
KP_DOWN	navigateDOWN
PAGE_DOWN	navigateDOWN

The Action Names recognized by this component

Action names

Action Name	Description
navigateHOME	show the first page
navigateEND	show the last page
navigateUP	show the previous page
navigateDOWN	show the next page

See Also:

Serialized Form

Nested Class Summary

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

static String

UI_CLASS_ID

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 java.awt.image.ImageObserver

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

Constructor Summary

NavigatorComponent()

Method Summary

PageView	getPageView() Returns the bound PageView component or null if not available.
ToolManager	getToolManager() Returns the ToolManager of the embedded navigator thumbnail component
NavigatorComponentUI	getUI() Returns the NavigatorComponentUI (!) used to render this component.
String	getUIClassID() Returns "NavigatorComponentUI", the UIDefaults key used to look up the name of the NavigatorComponentUI class that defines the look and feel for this component.
boolean	isApplyPageViewRenderSettings() Returns an indicator whether the sorter render pages according to the PageView render settings or not.
void	setApplyPageViewRenderSettings(boolean apply) Changes the sorter render behavior whether the pages rendered according to the PageView render settings or not.
void	setPageView(PageView pageView) Sets the page view holding the document of which the actually current page have to displayed en miniature.
void	setUI(NavigatorComponentUI ui) Sets the NavigatorComponentUI, the look and feel object that renders this component.
void	updateUI() Resets the UI property with the 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, 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

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, 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, transferFocusUpCycle

Methods inherited from class java.lang.Object

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

Field Detail

UI_CLASS_ID

public static final String UI_CLASS_ID

See Also:

Constant Field Values

Constructor Detail

NavigatorComponent

public NavigatorComponent()

Method Detail

updateUI

public void updateUI()

Resets the UI property with the value from the current look and feel.

Overrides:

updateUI in class JComponent

See Also:

UIManager.getUI(javax.swing.JComponent)

getUIClassID

public String getUIClassID()

Returns "NavigatorComponentUI", the UIDefaults key used to look up the name of the NavigatorComponentUI class that defines the look and feel for this component.

Overrides:

getUIClassID in class JComponent

Returns:

the string "ListUI"

See Also:

JComponent.getUIClassID(), UIDefaults.getUI(javax.swing.JComponent)

getUI

public NavigatorComponentUI getUI()

Returns the NavigatorComponentUI (!) used to render this component.

Returns:

the NavigatorComponentUI object that renders this component

setUI

public void setUI(NavigatorComponentUI ui)

Sets the NavigatorComponentUI, the look and feel object that renders this component.

Parameters:

ui - the NavigatorComponentUI object

See Also:

UIDefaults.getUI(javax.swing.JComponent)

getPageView

public PageView getPageView()

Returns the bound PageView component or null if not available.

Returns:

PageView or null if no page view is bind to this navigortor panel.

setPageView

public void setPageView(PageView pageView)

Sets the page view holding the document of which the actually current page have to displayed en miniature.

Parameters:

pageView - the page view holding the document

getToolManager

public final ToolManager getToolManager()

Returns the ToolManager of the embedded navigator thumbnail component

Returns:

the ToolManager or null if not available

setApplyPageViewRenderSettings

public void setApplyPageViewRenderSettings(boolean apply)

Changes the sorter render behavior whether the pages rendered according to the PageView render settings or not.

Parameters:

apply - whether the PageView render settings are honored for page rendering or not

isApplyPageViewRenderSettings

public boolean isApplyPageViewRenderSettings()

Returns an indicator whether the sorter render pages according to the PageView render settings or not.

Returns:

whether the viewer render settings are honored for page rendering