Oracle Help for Java API Reference
Release 4.2.7.0.0
B12198-01

oracle.help.navigator
Class Navigator

java.lang.Object
  |
  +--java.awt.Component
        |
        +--java.awt.Container
              |
              +--javax.swing.JComponent
                    |
                    +--javax.swing.JPanel
                          |
                          +--oracle.help.navigator.Navigator
All Implemented Interfaces:
javax.accessibility.Accessible, BaseNavigator, java.util.EventListener, java.awt.image.ImageObserver, oracle.help.library.LibraryListener, java.awt.MenuContainer, java.io.Serializable
Direct Known Subclasses:
LazyNavigator

public abstract class Navigator
extends javax.swing.JPanel
implements oracle.help.library.LibraryListener, BaseNavigator

The abstract Navigator class extends Swing's JPanel and implements the oracle.help.common.navigator.BaseNavigator interface to support operations common to all Navigators used in Oracle Help for Java. Subclasses of Navigator will almost always only have to implement the abstract methods on this class, namely:

See Also:
Serialized Form

Inner classes inherited from class javax.swing.JPanel
javax.swing.JPanel.AccessibleJPanel
 
Inner classes inherited from class javax.swing.JComponent
javax.swing.JComponent.AccessibleJComponent
 
Inner classes inherited from class java.awt.Container
java.awt.Container.AccessibleAWTContainer
 
Inner classes inherited from class java.awt.Component
java.awt.Component.AccessibleAWTComponent
 
Field Summary
protected  boolean filterByLabel
           
protected  java.lang.String label
           
protected  java.awt.Image labelImage
           
protected  oracle.help.library.Library library
           
protected  oracle.bali.share.event.ListenerManager listeners
           
protected  java.lang.String type
           
protected  java.util.ArrayList views
           
 
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
Navigator()
          Create a navigator
 
Method Summary
 void addNavigatorListener(oracle.help.navigator.NavigatorListener listener)
           
static Navigator createNavigator(java.lang.String type, oracle.help.library.Library library, java.lang.String label, java.awt.Image labelImage, boolean filterByLabel)
           
static Navigator createNavigator(java.lang.String type, java.lang.String label, java.awt.Image labelImage)
           
protected  oracle.help.common.View[] filterViewsByLabel(oracle.help.common.View[] views, java.lang.String label)
           
protected  void fireNavigatorEvent(oracle.help.navigator.NavigatorEvent event)
           
protected  void fireTopicActivated(oracle.help.common.Topic topic)
           
protected  void fireTopicActivated(oracle.help.common.Topic topic, int mode)
           
protected  void fireTopicSelected(oracle.help.common.Topic topic)
           
 java.lang.String getLabel()
          Get the label corresponding to the navigator.
 java.awt.Image getLabelImage()
           
 java.lang.String getType()
          Get the type corresponding to the navigator.
protected  oracle.help.common.View[] initBaseClass(oracle.help.library.Library library, java.lang.String type, java.lang.String label, java.awt.Image labelImage, boolean filterByLabel)
           
 void libraryChanged(oracle.help.library.LibraryEvent e)
           
 void removeNavigatorListener(oracle.help.navigator.NavigatorListener listener)
           
 void setLabel(java.lang.String label)
           
 void setLabelImage(java.awt.Image labelImage)
           
 
Methods inherited from class javax.swing.JPanel
getAccessibleContext, getUIClassID, paramString, updateUI
 
Methods inherited from class javax.swing.JComponent
addAncestorListener, addNotify, addPropertyChangeListener, addPropertyChangeListener, addVetoableChangeListener, computeVisibleRect, contains, createToolTip, disable, enable, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, fireVetoableChange, getActionForKeyStroke, getActionMap, getAlignmentX, getAlignmentY, getAutoscrolls, getBorder, getBounds, getClientProperty, getComponentGraphics, getConditionForKeyStroke, getDebugGraphicsOptions, getGraphics, getHeight, getInputMap, getInputMap, getInputVerifier, getInsets, getInsets, getListeners, getLocation, getMaximumSize, getMinimumSize, getNextFocusableComponent, getPreferredSize, getRegisteredKeyStrokes, getRootPane, getSize, getToolTipLocation, getToolTipText, getToolTipText, getTopLevelAncestor, getVerifyInputWhenFocusTarget, getVisibleRect, getWidth, getX, getY, grabFocus, hasFocus, hide, isDoubleBuffered, isFocusCycleRoot, isFocusTraversable, isLightweightComponent, isManagingFocus, isMaximumSizeSet, isMinimumSizeSet, isOpaque, isOptimizedDrawingEnabled, isPaintingTile, isPreferredSizeSet, isRequestFocusEnabled, isValidateRoot, paint, paintBorder, paintChildren, paintComponent, paintImmediately, paintImmediately, print, printAll, printBorder, printChildren, printComponent, processComponentKeyEvent, processFocusEvent, processKeyBinding, processKeyEvent, processMouseMotionEvent, putClientProperty, registerKeyboardAction, registerKeyboardAction, removeAncestorListener, removeNotify, removePropertyChangeListener, removePropertyChangeListener, removeVetoableChangeListener, repaint, repaint, requestDefaultFocus, requestFocus, resetKeyboardActions, reshape, revalidate, scrollRectToVisible, setActionMap, setAlignmentX, setAlignmentY, setAutoscrolls, setBackground, setBorder, setDebugGraphicsOptions, setDoubleBuffered, setEnabled, setFont, setForeground, setInputMap, setInputVerifier, setMaximumSize, setMinimumSize, setNextFocusableComponent, setOpaque, setPreferredSize, setRequestFocusEnabled, setToolTipText, setUI, setVerifyInputWhenFocusTarget, setVisible, unregisterKeyboardAction, update
 
Methods inherited from class java.awt.Container
add, add, add, add, add, addContainerListener, addImpl, countComponents, deliverEvent, doLayout, findComponentAt, findComponentAt, getComponent, getComponentAt, getComponentAt, getComponentCount, getComponents, getLayout, insets, invalidate, isAncestorOf, layout, list, list, locate, minimumSize, paintComponents, preferredSize, printComponents, processContainerEvent, processEvent, remove, remove, removeAll, removeContainerListener, setLayout, validate, validateTree
 
Methods inherited from class java.awt.Component
action, add, addComponentListener, addFocusListener, addHierarchyBoundsListener, addHierarchyListener, addInputMethodListener, addKeyListener, addMouseListener, addMouseMotionListener, bounds, checkImage, checkImage, coalesceEvents, contains, createImage, createImage, disableEvents, dispatchEvent, enable, enableEvents, enableInputMethods, getBackground, getBounds, getColorModel, getComponentOrientation, getCursor, getDropTarget, getFont, getFontMetrics, getForeground, getGraphicsConfiguration, getInputContext, getInputMethodRequests, getLocale, getLocation, getLocationOnScreen, getName, getParent, getPeer, getSize, getToolkit, getTreeLock, gotFocus, handleEvent, imageUpdate, inside, isDisplayable, isEnabled, isLightweight, isShowing, isValid, isVisible, keyDown, keyUp, list, list, list, location, lostFocus, mouseDown, mouseDrag, mouseEnter, mouseExit, mouseMove, mouseUp, move, nextFocus, paintAll, postEvent, prepareImage, prepareImage, processComponentEvent, processHierarchyBoundsEvent, processHierarchyEvent, processInputMethodEvent, processMouseEvent, remove, removeComponentListener, removeFocusListener, removeHierarchyBoundsListener, removeHierarchyListener, removeInputMethodListener, removeKeyListener, removeMouseListener, removeMouseMotionListener, repaint, repaint, repaint, resize, resize, setBounds, setBounds, setComponentOrientation, setCursor, setDropTarget, setLocale, setLocation, setLocation, setName, setSize, setSize, show, show, size, toString, transferFocus
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 
Methods inherited from interface oracle.help.common.navigator.BaseNavigator
addView, getCurrentSelection, getDefaultLabel, initNavigator, removeView
 

Field Detail

library

protected oracle.help.library.Library library

label

protected java.lang.String label

labelImage

protected java.awt.Image labelImage

type

protected java.lang.String type

filterByLabel

protected boolean filterByLabel

views

protected java.util.ArrayList views

listeners

protected oracle.bali.share.event.ListenerManager listeners
Constructor Detail

Navigator

public Navigator()
Create a navigator
Method Detail

createNavigator

public static Navigator createNavigator(java.lang.String type,
                                        java.lang.String label,
                                        java.awt.Image labelImage)
                                 throws oracle.help.navigator.NavigatorException

createNavigator

public static Navigator createNavigator(java.lang.String type,
                                        oracle.help.library.Library library,
                                        java.lang.String label,
                                        java.awt.Image labelImage,
                                        boolean filterByLabel)
                                 throws oracle.help.navigator.NavigatorException

addNavigatorListener

public void addNavigatorListener(oracle.help.navigator.NavigatorListener listener)

removeNavigatorListener

public void removeNavigatorListener(oracle.help.navigator.NavigatorListener listener)

setLabel

public void setLabel(java.lang.String label)

getType

public java.lang.String getType()
Description copied from interface: BaseNavigator
Get the type corresponding to the navigator.
Specified by:
getType in interface BaseNavigator

getLabel

public java.lang.String getLabel()
Description copied from interface: BaseNavigator
Get the label corresponding to the navigator.
Specified by:
getLabel in interface BaseNavigator

getLabelImage

public java.awt.Image getLabelImage()

setLabelImage

public void setLabelImage(java.awt.Image labelImage)

initBaseClass

protected final oracle.help.common.View[] initBaseClass(oracle.help.library.Library library,
                                                        java.lang.String type,
                                                        java.lang.String label,
                                                        java.awt.Image labelImage,
                                                        boolean filterByLabel)
                                                 throws oracle.help.navigator.NavigatorException

libraryChanged

public void libraryChanged(oracle.help.library.LibraryEvent e)
Specified by:
libraryChanged in interface oracle.help.library.LibraryListener

fireNavigatorEvent

protected void fireNavigatorEvent(oracle.help.navigator.NavigatorEvent event)

filterViewsByLabel

protected oracle.help.common.View[] filterViewsByLabel(oracle.help.common.View[] views,
                                                       java.lang.String label)

fireTopicActivated

protected void fireTopicActivated(oracle.help.common.Topic topic)

fireTopicActivated

protected void fireTopicActivated(oracle.help.common.Topic topic,
                                  int mode)

fireTopicSelected

protected void fireTopicSelected(oracle.help.common.Topic topic)

HELP ${project.version}

Copyright © 1998,2003, Oracle. All Rights Reserved.