com.highqsoft.fwk.application.help

Class FwkHelpTOCNavigator

java.lang.Object

java.awt.Component

java.awt.Container

javax.swing.JComponent

javax.help.JHelpNavigator

javax.help.JHelpTOCNavigator

com.highqsoft.fwk.application.help.FwkHelpTOCNavigator

All Implemented Interfaces:

FwkInterface, java.awt.image.ImageObserver, java.awt.MenuContainer, java.io.Serializable, javax.accessibility.Accessible

public class FwkHelpTOCNavigator
extends javax.help.JHelpTOCNavigator
implements FwkInterface

The FwkHelpTOCNavigator.

Since:

$Date: 2017/04/06 13:29:03 $

Version:

$Revision: 1.13 $

Author:

Andreas Hofmann

See Also:

, Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class javax.help.JHelpNavigator

javax.help.JHelpNavigator.AccessibleJHelpNavigator

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

Fields

Modifier and Type	Field and Description
static java.lang.String	version

Fields inherited from class javax.help.JHelpNavigator

helpModel, type

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

Constructors

Constructor and Description
FwkHelpTOCNavigator(javax.help.HelpSet hs, java.lang.String name, java.lang.String label, java.net.URL data) Creates a TOC navigator with explicit arguments.
FwkHelpTOCNavigator(javax.help.NavigatorView view) Create a TOC navigator
FwkHelpTOCNavigator(javax.help.NavigatorView view, javax.help.HelpModel model) Creates a TOC navigator.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	canMerge(javax.help.NavigatorView view) Determines if this instance of a JHelpNavigator can merge its data with another one.
java.lang.String	getUIClassID() The UID for this JComponent.
java.lang.String	getVersion() Return the version string of the FWK component.
void	merge(javax.help.NavigatorView view) Merges a NavigatorView into this instance.
void	release() Release the object.
void	remove(javax.help.NavigatorView view) Removes a NavigatorView from this instance.
java.lang.String	toString() Get the string representation of the object.

Methods inherited from class javax.help.JHelpTOCNavigator

collapseID, expandID

Methods inherited from class javax.help.JHelpNavigator

addHelpModelListener, createParams, getAccessibleContext, getIcon, getModel, getNavigatorLabel, getNavigatorLabel, getNavigatorName, getNavigatorView, getUI, removeHelpModelListener, setModel, 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, hide, isDoubleBuffered, isLightweightComponent, isManagingFocus, isOpaque, isOptimizedDrawingEnabled, isPaintingForPrint, isPaintingOrigin, 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, 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, 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, transferFocus, transferFocusBackward, transferFocusUpCycle

Methods inherited from class java.lang.Object

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

Field Detail

version

public static final java.lang.String version

See Also:

Constant Field Values

Constructor Detail

FwkHelpTOCNavigator

public FwkHelpTOCNavigator(javax.help.NavigatorView view)

Create a TOC navigator

Parameters:

view - The NavigatorView. If view is null it creates a FwkTOCNavigator without a HelpModel and a null NavigatorView.

FwkHelpTOCNavigator

public FwkHelpTOCNavigator(javax.help.NavigatorView view,
                   javax.help.HelpModel model)

Creates a TOC navigator.

Parameters:

view - The NavigatorView. If view is null it creates a FwkTOCNavigator with a null NavigatorView.

model - The model for the Navigator. If model is null it creates a FwkTOCNavigator witout a model.

FwkHelpTOCNavigator

public FwkHelpTOCNavigator(javax.help.HelpSet hs,
                   java.lang.String name,
                   java.lang.String label,
                   java.net.URL data)
                    throws javax.help.InvalidNavigatorViewException

Creates a TOC navigator with explicit arguments. Note that this should not throw an InvalidNavigatorViewException since the type is implicitly passed.

Parameters:

hs - HelpSet

name - The name indentifying this HelpSet.

label - The label to use (for this locale).

data - The "data" part of the parameters, a URL location of the TOC data.

Throws:

javax.help.InvalidNavigatorViewException

Method Detail

getVersion

public java.lang.String getVersion()

Description copied from interface: FwkInterface

Return the version string of the FWK component.

Specified by:

getVersion in interface FwkInterface

release

public void release()

Release the object.

Specified by:

release in interface FwkInterface

getUIClassID

public java.lang.String getUIClassID()

The UID for this JComponent.

Overrides:

getUIClassID in class javax.help.JHelpTOCNavigator

canMerge

public boolean canMerge(javax.help.NavigatorView view)

Determines if this instance of a JHelpNavigator can merge its data with another one.

Overrides:

canMerge in class javax.help.JHelpTOCNavigator

Parameters:

view - The data to merge.

Returns:

Whether it can be merged.

See Also:

merge(), remove()

merge

public void merge(javax.help.NavigatorView view)

Merges a NavigatorView into this instance.

Overrides:

merge in class javax.help.JHelpTOCNavigator

Parameters:

view - The data to merge. This must be a TOCView.

Throws:

java.lang.IllegalArgumentException

java.lang.IllegalStateException

See Also:

canMerge(), remove()

remove

public void remove(javax.help.NavigatorView view)

Removes a NavigatorView from this instance.

Overrides:

remove in class javax.help.JHelpTOCNavigator

Parameters:

view - The data to merge.

Throws:

java.lang.IllegalArgumentException

java.lang.IllegalStateException

See Also:

canMerge(), merge()

toString

public java.lang.String toString()

Get the string representation of the object.

Overrides:

toString in class java.awt.Component

Returns:

The string representation of the object.