Skip navigation links

Oracle Fusion Middleware Java API Reference for Oracle Help
12c (12.1.2)

E48720-01


oracle.help.navigator
Class Navigator

java.lang.Object
  extended by java.awt.Component
      extended by java.awt.Container
          extended by javax.swing.JComponent
              extended by javax.swing.JPanel
                  extended by oracle.help.navigator.Navigator

All Implemented Interfaces:
java.awt.image.ImageObserver, java.awt.MenuContainer, java.io.Serializable, java.util.EventListener, javax.accessibility.Accessible, BaseNavigator, oracle.help.library.LibraryListener
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

Nested Class Summary

 

Nested classes/interfaces inherited from class javax.swing.JPanel
javax.swing.JPanel.AccessibleJPanel

 

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.BaselineResizeBehavior, java.awt.Component.BltBufferStrategy, java.awt.Component.FlipBufferStrategy

 

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

 

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
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
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
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)

Skip navigation links

Oracle Fusion Middleware Java API Reference for Oracle Help
12c (12.1.2)

E48720-01


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