com.logicaldoc.web.navigation
Class PageContentBean

java.lang.Object
  com.icesoft.faces.component.tree.IceUserObject
      com.logicaldoc.web.navigation.PageContentBean

Direct Known Subclasses:

Directory

public class PageContentBean
extends com.icesoft.faces.component.tree.IceUserObject

The PageContentBean class is responsible for holding state information which will allow a TreeNavigation and NavigationBean display dynamic content.

Since:

3.0

Author:

Marco Meschieri - Logical Objects

Field Summary

Fields inherited from class com.icesoft.faces.component.tree.IceUserObject

action, branchContractedIcon, branchExpandedIcon, expanded, icon, leaf, leafIcon, text, tooltip, treeNode, wrapper

Constructor Summary

PageContentBean()

PageContentBean(long menuId)

PageContentBean(long menuId, java.lang.String template)

PageContentBean(com.logicaldoc.core.security.Menu menu)

PageContentBean(java.lang.String contentName)

PageContentBean(java.lang.String contentName, java.lang.String template)

Method Summary

boolean	equals(java.lang.Object obj)
java.lang.String	getContentName() Gets the template name to display in the showcase.jspx.
java.lang.String	getContentTitle() Get the text to be displayed as the content title.
java.lang.String	getDisplayText() Gets the menu display text.
java.lang.String	getIcon()
com.logicaldoc.core.security.Menu	getMenu()
long	getMenuId()
NavigationBean	getNavigationSelection() Gets the navigation callback.
java.lang.String	getTemplate()
boolean	isPageContent() Does the node contain content.
void	onSelect(javax.faces.event.ActionEvent event) Item selection handler
void	setContentName(java.lang.String templateName) Sets the template name to be displayed when selected in tree.
void	setContentTitle(java.lang.String menuContentTitle) Sets the menu content title.
void	setDisplayText(java.lang.String menuDisplayText) Sets the text to be displayed in the menu.
void	setIcon(java.lang.String icon)
void	setMenu(com.logicaldoc.core.security.Menu menu)
void	setMenuId(long menuId)
void	setNavigationSelection(NavigationBean navigationBean) Sets the navigation callback.
void	setPageContent(boolean pageContent) Sets the page content.
void	setTemplate(java.lang.String menuContentInclusionFile) This is necessary for the Facelets version of component-showcase.
java.lang.String	toString()

Methods inherited from class com.icesoft.faces.component.tree.IceUserObject

action, getAction, getBranchContractedIcon, getBranchExpandedIcon, getFamily, getLeafIcon, getRowIndex, getText, getTooltip, getTreeNode, getWrapper, isExpanded, isLeaf, setAction, setBranchContractedIcon, setBranchExpandedIcon, setExpanded, setLeaf, setLeafIcon, setRowIndex, setText, setTooltip, setTreeNode, setWrapper

Methods inherited from class java.lang.Object

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

Constructor Detail

PageContentBean

public PageContentBean(long menuId)

PageContentBean

public PageContentBean(long menuId,
                       java.lang.String template)

PageContentBean

public PageContentBean(java.lang.String contentName)

PageContentBean

public PageContentBean(java.lang.String contentName,
                       java.lang.String template)

PageContentBean

public PageContentBean()

PageContentBean

public PageContentBean(com.logicaldoc.core.security.Menu menu)

Method Detail

getNavigationSelection

public NavigationBean getNavigationSelection()

Gets the navigation callback.

Returns:

NavigationBean.

setNavigationSelection

public void setNavigationSelection(NavigationBean navigationBean)

Sets the navigation callback.

Parameters:

navigationBean - controls selected panel state.

getContentName

public java.lang.String getContentName()

Gets the template name to display in the showcase.jspx. The template is a panel in a panel stack which will be made visible.

Returns:

panel stack template name.

setContentName

public void setContentName(java.lang.String templateName)

Sets the template name to be displayed when selected in tree. Selection will only occur if pageContent is true.

Parameters:

contentName - valid panel name in showcase.jspx

getDisplayText

public java.lang.String getDisplayText()

Gets the menu display text. This text will be shown in the navigation control.

Returns:

menu display text.

setDisplayText

public void setDisplayText(java.lang.String menuDisplayText)

Sets the text to be displayed in the menu. This text string must match a resource property in com.icesoft.icefaces.samples.showcase.resources.messages

Parameters:

displayText - menu text to display

getContentTitle

public java.lang.String getContentTitle()

Get the text to be displayed as the content title. This text string must match resource property in com.icesoft.icefaces.samples.showcase.resources.messages

Returns:

menu content title

setContentTitle

public void setContentTitle(java.lang.String menuContentTitle)

Sets the menu content title.

Parameters:

contentTitle - menu content title name.

getTemplate

public java.lang.String getTemplate()

setTemplate

public void setTemplate(java.lang.String menuContentInclusionFile)

This is necessary for the Facelets version of component-showcase. Unlike the JSP version of component-showcase, which uses static includes, the Facelets version uses dynamic inclusion tied to an EL expression, which will call getMenuContentInclusionFile().

Parameters:

template - The server-side path to the file to be included

isPageContent

public boolean isPageContent()

Does the node contain content.

Returns:

true if the page contains content; otherwise, false.

setPageContent

public void setPageContent(boolean pageContent)

Sets the page content.

Parameters:

pageContent - True if the page contains content; otherwise, false.

getMenu

public com.logicaldoc.core.security.Menu getMenu()

getMenuId

public long getMenuId()

setMenu

public void setMenu(com.logicaldoc.core.security.Menu menu)

setMenuId

public void setMenuId(long menuId)

getIcon

public java.lang.String getIcon()

Overrides:

getIcon in class com.icesoft.faces.component.tree.IceUserObject

setIcon

public void setIcon(java.lang.String icon)

onSelect

public void onSelect(javax.faces.event.ActionEvent event)

Item selection handler

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object

toString

public java.lang.String toString()

Overrides:

toString in class com.icesoft.faces.component.tree.IceUserObject