Venice 0.751beta

nz.org.venice.prefs.settings
Class HelpModuleSettings

java.lang.Object
  extended bynz.org.venice.prefs.settings.AbstractSettings
      extended bynz.org.venice.prefs.settings.HelpModuleSettings
All Implemented Interfaces:
Settings

public class HelpModuleSettings
extends AbstractSettings


Field Summary
 
Fields inherited from interface nz.org.venice.prefs.settings.Settings
ALERTS, ANALYSER, ANNMODULE, ANNRESULTS, CHART, CHARTMODULE, FRAME, GAMODULE, GARESULTS, GPMODULE, GPRESULTS, GRAPHS, HELP, HELPMODULE, MENUS, MODULE, PAPERTRADEMODULE, PAPERTRADERESULTS, PORTFOLIO, PORTFOLIOMODULE, PORTFOLIOTABLEMODULE, PREFERENCES, PREFERENCESMODULE, PREFS, QUOTEMODULE, ROOTMODULE, TABLE, TRANSACTIONMODULE, WATCHSCREENMODULE
 
Constructor Summary
HelpModuleSettings()
          Default HelpModuleSettings constructor
HelpModuleSettings(java.lang.String title)
          Create a HelpModuleSettings object using title as key
 
Method Summary
 Module getModule(javax.swing.JDesktopPane desktop)
          Return a HelpModule based on this Settings object
 int getPositionInStack()
          Return the position in a stack of visited pages
 java.util.Stack getVisitedPages()
          Return a stack of visitedPages
 void setPositionInStack(int positionInStack)
          Set the position in a stack of visited pages
 void setVisitedPages(java.util.Stack visitedPages)
          Set the stack of help pages visited.
 
Methods inherited from class nz.org.venice.prefs.settings.AbstractSettings
getGroup, getHBarPolicy, getHBarValue, getKey, getTitle, getType, getVBarPolicy, getVBarValue, setGroup, setHBarPolicy, setHBarValue, setKey, setScrollBarValues, setTitle, setType, setVBarPolicy, setVBarValue, toString, updateScrollPane
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

HelpModuleSettings

public HelpModuleSettings()
Default HelpModuleSettings constructor


HelpModuleSettings

public HelpModuleSettings(java.lang.String title)
Create a HelpModuleSettings object using title as key

Parameters:
title - The title of the HelpModule
Method Detail

getVisitedPages

public java.util.Stack getVisitedPages()
Return a stack of visitedPages

Returns:
A stack representing help pages visited

setVisitedPages

public void setVisitedPages(java.util.Stack visitedPages)
Set the stack of help pages visited.

Parameters:
visitedPages - A stack

getPositionInStack

public int getPositionInStack()
Return the position in a stack of visited pages

Returns:
The position in the stack

setPositionInStack

public void setPositionInStack(int positionInStack)
Set the position in a stack of visited pages

Parameters:
positionInStack - An index to the stack

getModule

public Module getModule(javax.swing.JDesktopPane desktop)
Return a HelpModule based on this Settings object

Specified by:
getModule in interface Settings
Overrides:
getModule in class AbstractSettings
Parameters:
desktop - The Venice desktop
Returns:
A HelpModule

Venice 0.751beta