com.jgoodies.skeleton.model
Class DynamicHelpModel

java.lang.Object
  extended by com.jgoodies.binding.beans.Model
      extended by com.jgoodies.skeleton.model.DynamicHelpModel
All Implemented Interfaces:
com.jgoodies.binding.beans.Observable, Serializable

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

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

Version:
$Revision: 1.11 $
Author:
Karsten Lentzsch
See Also:
MainModel, 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

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.

registerHelp

public void registerHelp(Class domainClass,
                         TreeNode node)
Registers a help tree for a domain class.

Parameters:
domainClass - the class associated with the given node
node - the help tree node associated with the domainClass

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.

isHelpVisible

public boolean isHelpVisible()
Answers whether the dynamic help is visible or not.

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

setHelpVisible

public void setHelpVisible(boolean newVisibility)
Sets a new visibility for the help viewer.

Parameters:
newVisibility - the help page to set
See Also:
isHelpVisible()


Copyright © 2002-2008 JGoodies Karsten Lentzsch. All Rights Reserved.