com.melloware.jukes.gui.tool
Class DynamicHelpModule

java.lang.Object
  com.jgoodies.binding.beans.Model
      com.melloware.jukes.gui.tool.DynamicHelpModule

All Implemented Interfaces:

com.jgoodies.binding.beans.Observable, Serializable

public final class DynamicHelpModule
extends com.jgoodies.binding.beans.Model

Provides bound bean properties for the help tree model, the help page and the help visibility.

Copyright (c) 1999-2007 Melloware, Inc.

Version:

4.0

Author:

Emil A. Lefkof III

See Also:

Serialized Form

Field Summary

static String	PROPERTYNAME_HELP_PAGE
static String	PROPERTYNAME_HELP_TREE_MODEL
static String	PROPERTYNAME_HELP_VISIBLE

Method Summary

URL	getHelpPage() Returns the current help page, a URL.
TreeModel	getHelpTreeModel() Returns the tree model for the help tree.
TreeSelectionModel	getHelpTreeSelectionModel() Returns the fixed selection model for the navigation tree.
boolean	isHelpVisible() Answers whether the dynamic help is visible or not.
void	registerHelp(Class domainClass, TreeNode node) Registers a help tree for a domain class.
void	setHelpVisible(boolean newVisibility) Sets a new visibility for the help viewer.

Methods inherited from class com.jgoodies.binding.beans.Model

addPropertyChangeListener, addPropertyChangeListener, addVetoableChangeListener, addVetoableChangeListener, equals, fireIndexedPropertyChange, fireIndexedPropertyChange, fireIndexedPropertyChange, fireMultiplePropertiesChanged, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, fireVetoableChange, fireVetoableChange, fireVetoableChange, fireVetoableChange, fireVetoableChange, fireVetoableChange, fireVetoableChange, getPropertyChangeListeners, getPropertyChangeListeners, getVetoableChangeListeners, getVetoableChangeListeners, removePropertyChangeListener, removePropertyChangeListener, removeVetoableChangeListener, removeVetoableChangeListener

Methods inherited from class java.lang.Object

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

Field Detail

PROPERTYNAME_HELP_TREE_MODEL

public static final String PROPERTYNAME_HELP_TREE_MODEL

See Also:

Constant Field Values

PROPERTYNAME_HELP_PAGE

public static final String PROPERTYNAME_HELP_PAGE

See Also:

Constant Field Values

PROPERTYNAME_HELP_VISIBLE

public static final String PROPERTYNAME_HELP_VISIBLE

See Also:

Constant Field Values

Method Detail

getHelpPage

public URL getHelpPage()

Returns the current help page, a URL. This page will be updated if the selection in the help tree changes.

Returns:

the URL for the currently selected help page.

getHelpTreeModel

public TreeModel getHelpTreeModel()

Returns the tree model for the help tree.

Returns:

the tree model for the help tree.

getHelpTreeSelectionModel

public TreeSelectionModel getHelpTreeSelectionModel()

Returns the fixed selection model for the navigation tree.

Returns:

the fixed selection model for the navigation tree.

setHelpVisible

public void setHelpVisible(boolean newVisibility)

Sets a new visibility for the help viewer.

Parameters:

newVisibility - the help page to set

See Also:

isHelpVisible()

isHelpVisible

public boolean isHelpVisible()

Answers whether the dynamic help is visible or not.

Returns:

true if the help viewer is visible, false if hidden.

registerHelp

public void registerHelp(Class domainClass,
                         TreeNode node)

Registers a help tree for a domain class.