com.highqsoft.fwk.application.help

Class FwkHelpUI

java.lang.Object

javax.swing.plaf.ComponentUI

javax.help.plaf.HelpUI

com.highqsoft.fwk.application.help.FwkHelpUI

All Implemented Interfaces:

FwkInterface, java.beans.PropertyChangeListener, java.io.Serializable, java.util.EventListener

public class FwkHelpUI
extends javax.help.plaf.HelpUI
implements FwkInterface, java.beans.PropertyChangeListener

The UI for FwkHelp.

Since:

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

Version:

$Revision: 1.14 $

Author:

Andreas Hofmann

See Also:

, Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected FwkHelp	help The help belongs to that ui.
protected java.util.Vector	navs The vector contains the navigators.
protected javax.swing.JSplitPane	splitPane The split pane
protected javax.swing.JTabbedPane	tabbedPane The tabbed pane.
protected javax.swing.JToolBar	toolbar The toolbar.
static java.lang.String	version

Constructor Summary

Constructors

Constructor and Description
FwkHelpUI() Constructors.
FwkHelpUI(javax.help.JHelp b) The constructor receiving the help.

Method Summary

Methods

Modifier and Type	Method and Description
void	addNavigator(javax.help.JHelpNavigator nav) Add a new navigator.
static javax.swing.plaf.ComponentUI	createUI(javax.swing.JComponent x) Install the ui.
javax.help.JHelpNavigator	getCurrentNavigator() Retrieves the current navigator.
protected javax.help.HelpModel	getModel() Retrieves the model.
java.awt.Dimension	getPreferredSize(javax.swing.JComponent c)
java.lang.String	getVersion() Return the version string of the FWK component.
void	goBack() Go one step back in history.
void	goForward() Go one step forward in history.
void	installUI(javax.swing.JComponent c) Install the UI.
void	propertyChange(java.beans.PropertyChangeEvent event)
void	release() Release the object.
void	removeNavigator(javax.help.JHelpNavigator nav) Remove a navigator from UI.
void	setCurrentNavigator(javax.help.JHelpNavigator nav) Sets the current Navigator.
java.lang.String	toString() Get the string representation of the object.

Methods inherited from class javax.swing.plaf.ComponentUI

contains, getAccessibleChild, getAccessibleChildrenCount, getBaseline, getBaselineResizeBehavior, getMaximumSize, getMinimumSize, paint, uninstallUI, update

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

help

protected FwkHelp help

The help belongs to that ui.

toolbar

protected javax.swing.JToolBar toolbar

The toolbar.

splitPane

protected javax.swing.JSplitPane splitPane

The split pane

tabbedPane

protected javax.swing.JTabbedPane tabbedPane

The tabbed pane.

navs

protected java.util.Vector navs

The vector contains the navigators.

Constructor Detail

FwkHelpUI

public FwkHelpUI()

Constructors.

FwkHelpUI

public FwkHelpUI(javax.help.JHelp b)

The constructor receiving the help.

Parameters:

help - The help (unused).

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

createUI

public static javax.swing.plaf.ComponentUI createUI(javax.swing.JComponent x)

Install the ui.

installUI

public void installUI(javax.swing.JComponent c)

Install the UI.

Overrides:

installUI in class javax.swing.plaf.ComponentUI

Parameters:

c - The help component.

getPreferredSize

public java.awt.Dimension getPreferredSize(javax.swing.JComponent c)

Overrides:

getPreferredSize in class javax.swing.plaf.ComponentUI

addNavigator

public void addNavigator(javax.help.JHelpNavigator nav)

Add a new navigator.

Specified by:

addNavigator in class javax.help.plaf.HelpUI

Parameters:

the - navigator to be added.

removeNavigator

public void removeNavigator(javax.help.JHelpNavigator nav)

Remove a navigator from UI.

Specified by:

removeNavigator in class javax.help.plaf.HelpUI

Parameters:

nav - The navigator to be removed.

getCurrentNavigator

public javax.help.JHelpNavigator getCurrentNavigator()

Retrieves the current navigator.

Specified by:

getCurrentNavigator in class javax.help.plaf.HelpUI

Returns:

The current navigator.

setCurrentNavigator

public void setCurrentNavigator(javax.help.JHelpNavigator nav)

Sets the current Navigator.

Specified by:

setCurrentNavigator in class javax.help.plaf.HelpUI

Parameters:

navigator - The navigator

Throws:

throws - InvalidNavigatorException if not one of the HELPUI navigators.

getModel

protected javax.help.HelpModel getModel()

Retrieves the model.

Returns:

The help model.

propertyChange

public void propertyChange(java.beans.PropertyChangeEvent event)

Specified by:

propertyChange in interface java.beans.PropertyChangeListener

goBack

public void goBack()

Go one step back in history.

goForward

public void goForward()

Go one step forward in history.

toString

public java.lang.String toString()

Get the string representation of the object.

Overrides:

toString in class java.lang.Object

Returns:

The string representation of the object.