com.sun.webui.jsf.bean
Class HelpBackingBean

java.lang.Object
  extended by com.sun.webui.jsf.bean.HelpBackingBean

public class HelpBackingBean
extends java.lang.Object

This class defines a backing bean required for use by the HelpWindow component.


Field Summary
static java.lang.String CONTENT_FRAME_NAME
           
static java.lang.String HELP_CONTENTS_TREE_ID
           
static java.lang.String HELP_INDEX_TREE_ID
           
 
Constructor Summary
HelpBackingBean()
          Creates a new instance of HelpBackingBean.
 
Method Summary
 void contentsTabClicked()
          The action method invoked when the contents tab is clicked.
 void doSearch()
          The action method invoked when the search button is clicked.
 java.lang.String getBackButtonIcon()
           
 java.lang.String getBackButtonText()
           
 java.lang.String getBodyClassName()
           
 java.lang.String getBottomFrameUrl()
           
 java.lang.String getbuttonBodyClassName()
           
 java.lang.String getButtonClassName()
           
 java.lang.String getButtonFrameTitle()
           
 java.lang.String getButtonFrameUrl()
           
 java.lang.String getButtonNavHeadTitle()
           
 java.lang.String getContentFrameTitle()
           
 java.lang.String getContentsText()
           
 Tree getContentsTree()
          Returns the contents tab tree.
 java.lang.String getForwardButtonIcon()
           
 java.lang.String getForwardButtonText()
           
 java.lang.String getHelpSetPath()
          Get the value of the helpSetPath managed bean property.
 int getHttpPort()
           
 java.lang.String getIndexText()
           
 Tree getIndexTree()
          Returns the index tab tree.
 java.lang.String getinlineHelpClassName()
           
 java.lang.String getJspPath()
          Get the value of the jspPath managed bean property.
 java.lang.String getLocalizedHelpPath()
           
 java.lang.String getNavFrameTitle()
           
 java.lang.String getNavigatorHeadTitle()
           
 java.lang.String getNavigatorUrl()
           
 java.lang.String getNoFrames()
           
 java.lang.String getPrintButtonIcon()
           
 java.lang.String getPrintButtonText()
           
 java.lang.String getRequestScheme()
          Get the scheme that will be used for help set requests.
 java.lang.String getSearchClassName()
           
 java.lang.String getSearchLabel()
           
 PanelGroup getSearchPanel()
          Get the PanelGroup to use for the search tab content.
 PanelGroup getSearchResultsPanel()
          Get the PanelGroup to use for the search results.
 java.lang.String getSearchText()
           
 java.lang.String getStepTabClassName()
           
 java.lang.String getTipsHeadTitle()
           
 java.lang.String getTipsImprove()
           
 java.lang.String getTipsImprove1()
           
 java.lang.String getTipsImprove2()
           
 java.lang.String getTipsImprove3()
           
 java.lang.String getTipsImprove4()
           
 Hyperlink getTipsLink()
           
 java.lang.String getTipsNote()
           
 java.lang.String getTipsNoteDetails()
           
 java.lang.String getTipsSearch()
           
 java.lang.String getTipsSearch1()
           
 java.lang.String getTipsSearch2()
           
 java.lang.String getTipsSearch3()
           
 java.lang.String getTipsSearch4()
           
 java.lang.String getTipsTitle()
           
 java.lang.String getTitleClassName()
           
 void indexTabClicked()
          The action method invoked when the index tab is clicked.
 void searchTabClicked()
          The action method invoked when the search tab is clicked.
 void setBottomFrameUrl(java.lang.String url)
           
 void setButtonFrameTitle(java.lang.String s)
           
 void setButtonFrameUrl(java.lang.String url)
           
 void setButtonNavHeadTitle(java.lang.String s)
           
 void setContentFrameTitle(java.lang.String s)
           
 void setContentsTree(Tree tree)
          Sets the contents tab tree.
 void setHelpSetPath(java.lang.String path)
          Set the value of the helpSetPath managed bean property.
 void setHttpPort(int port)
           
 void setIndexTree(Tree tree)
          Sets the index tab tree.
 void setJspPath(java.lang.String path)
          Set the value of the jspPath managed bean property.
 void setLocalizedHelpPath(java.lang.String s)
           
 void setNavFrameTitle(java.lang.String s)
           
 void setNavigatorHeadTitle(java.lang.String s)
           
 void setNavigatorUrl(java.lang.String url)
           
 void setNoFrames(java.lang.String s)
           
 void setRequestScheme(java.lang.String scheme)
          Set the scheme that will be used for help set requests.
 void setSearchLabel(java.lang.String s)
           
 void setSearchPanel(PanelGroup panel)
          Set the PanelGroup to use for the search tab content.
 void setSearchResultsPanel(PanelGroup panel)
          Set the PanelGroup to use for the search results.
 void setTipsHeadTitle(java.lang.String s)
           
 void setTipsLink(Hyperlink link)
           
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

HELP_CONTENTS_TREE_ID

public static final java.lang.String HELP_CONTENTS_TREE_ID
See Also:
Constant Field Values

HELP_INDEX_TREE_ID

public static final java.lang.String HELP_INDEX_TREE_ID
See Also:
Constant Field Values

CONTENT_FRAME_NAME

public static final java.lang.String CONTENT_FRAME_NAME
See Also:
Constant Field Values
Constructor Detail

HelpBackingBean

public HelpBackingBean()
Creates a new instance of HelpBackingBean.

Method Detail

getNavigatorUrl

public java.lang.String getNavigatorUrl()

setNavigatorUrl

public void setNavigatorUrl(java.lang.String url)

getBottomFrameUrl

public java.lang.String getBottomFrameUrl()

setBottomFrameUrl

public void setBottomFrameUrl(java.lang.String url)

getButtonFrameUrl

public java.lang.String getButtonFrameUrl()

setButtonFrameUrl

public void setButtonFrameUrl(java.lang.String url)

getRequestScheme

public java.lang.String getRequestScheme()

Get the scheme that will be used for help set requests.

The default is "http".

Returns:
The request scheme used for JavaHelp requests.

setRequestScheme

public void setRequestScheme(java.lang.String scheme)

Set the scheme that will be used for help set requests.

Parameters:
scheme - The request scheme to use for JavaHelp requests (i.e. "https").

getHelpSetPath

public java.lang.String getHelpSetPath()
Get the value of the helpSetPath managed bean property.

Returns:
The value of the helpSetPath managed bean property.

setHelpSetPath

public void setHelpSetPath(java.lang.String path)
Set the value of the helpSetPath managed bean property.

Parameters:
path - The value of the helpSetPath managed bean property.

getJspPath

public java.lang.String getJspPath()
Get the value of the jspPath managed bean property.

Returns:
The value of the jspPath managed bean property.

setJspPath

public void setJspPath(java.lang.String path)
Set the value of the jspPath managed bean property.

Parameters:
path - The value of the jspPath managed bean property.

contentsTabClicked

public void contentsTabClicked()
The action method invoked when the contents tab is clicked.


indexTabClicked

public void indexTabClicked()
The action method invoked when the index tab is clicked.


searchTabClicked

public void searchTabClicked()
The action method invoked when the search tab is clicked.


doSearch

public void doSearch()
The action method invoked when the search button is clicked.


getIndexTree

public Tree getIndexTree()
Returns the index tab tree.

Returns:
The Tree component for the index tree.

setIndexTree

public void setIndexTree(Tree tree)
Sets the index tab tree.

Parameters:
tree - The Tree to use for the index tab tree.

getContentsTree

public Tree getContentsTree()
Returns the contents tab tree.

Returns:
The Tree component for the contents tab.

setContentsTree

public void setContentsTree(Tree tree)
Sets the contents tab tree.

Parameters:
tree - The Tree to use for the contents tab tree.

getSearchPanel

public PanelGroup getSearchPanel()
Get the PanelGroup to use for the search tab content.

Returns:
The PanelGroup to use for the search tab content.

setSearchPanel

public void setSearchPanel(PanelGroup panel)
Set the PanelGroup to use for the search tab content.

Parameters:
panel - The PanelGroup to use for the search tab content.

getSearchResultsPanel

public PanelGroup getSearchResultsPanel()
Get the PanelGroup to use for the search results.

Returns:
The PanelGroup to use for the search results.

setSearchResultsPanel

public void setSearchResultsPanel(PanelGroup panel)
Set the PanelGroup to use for the search results.

Parameters:
panel - The PanelGroup to use for the search results.

getTipsLink

public Hyperlink getTipsLink()

setTipsLink

public void setTipsLink(Hyperlink link)

getTipsTitle

public java.lang.String getTipsTitle()

getTipsImprove

public java.lang.String getTipsImprove()

getTipsImprove1

public java.lang.String getTipsImprove1()

getTipsImprove2

public java.lang.String getTipsImprove2()

getTipsImprove3

public java.lang.String getTipsImprove3()

getTipsImprove4

public java.lang.String getTipsImprove4()

getTipsNote

public java.lang.String getTipsNote()

getTipsNoteDetails

public java.lang.String getTipsNoteDetails()

getTipsSearch

public java.lang.String getTipsSearch()

getTipsSearch1

public java.lang.String getTipsSearch1()

getTipsSearch2

public java.lang.String getTipsSearch2()

getTipsSearch3

public java.lang.String getTipsSearch3()

getTipsSearch4

public java.lang.String getTipsSearch4()

getBackButtonText

public java.lang.String getBackButtonText()

getForwardButtonText

public java.lang.String getForwardButtonText()

getPrintButtonText

public java.lang.String getPrintButtonText()

getContentsText

public java.lang.String getContentsText()

getIndexText

public java.lang.String getIndexText()

getSearchText

public java.lang.String getSearchText()

getLocalizedHelpPath

public java.lang.String getLocalizedHelpPath()

setLocalizedHelpPath

public void setLocalizedHelpPath(java.lang.String s)

getBackButtonIcon

public java.lang.String getBackButtonIcon()

getForwardButtonIcon

public java.lang.String getForwardButtonIcon()

getPrintButtonIcon

public java.lang.String getPrintButtonIcon()

getHttpPort

public int getHttpPort()

setHttpPort

public void setHttpPort(int port)

getSearchLabel

public java.lang.String getSearchLabel()

setSearchLabel

public void setSearchLabel(java.lang.String s)

getNavFrameTitle

public java.lang.String getNavFrameTitle()

setNavFrameTitle

public void setNavFrameTitle(java.lang.String s)

getButtonFrameTitle

public java.lang.String getButtonFrameTitle()

setButtonFrameTitle

public void setButtonFrameTitle(java.lang.String s)

getContentFrameTitle

public java.lang.String getContentFrameTitle()

setContentFrameTitle

public void setContentFrameTitle(java.lang.String s)

getNoFrames

public java.lang.String getNoFrames()

setNoFrames

public void setNoFrames(java.lang.String s)

getButtonNavHeadTitle

public java.lang.String getButtonNavHeadTitle()

setButtonNavHeadTitle

public void setButtonNavHeadTitle(java.lang.String s)

getNavigatorHeadTitle

public java.lang.String getNavigatorHeadTitle()

setNavigatorHeadTitle

public void setNavigatorHeadTitle(java.lang.String s)

getTipsHeadTitle

public java.lang.String getTipsHeadTitle()

setTipsHeadTitle

public void setTipsHeadTitle(java.lang.String s)

getBodyClassName

public java.lang.String getBodyClassName()

getButtonClassName

public java.lang.String getButtonClassName()

getinlineHelpClassName

public java.lang.String getinlineHelpClassName()

getSearchClassName

public java.lang.String getSearchClassName()

getStepTabClassName

public java.lang.String getStepTabClassName()

getTitleClassName

public java.lang.String getTitleClassName()

getbuttonBodyClassName

public java.lang.String getbuttonBodyClassName()


Copyright © 2008 Sun Microsystems, Inc. All Rights Reserved.