net.sf.tacos.components
Class SiteMapComponent

java.lang.Object
  org.apache.hivemind.impl.BaseLocatable
      org.apache.tapestry.AbstractComponent
          org.apache.tapestry.BaseComponent
              net.sf.tacos.components.SiteMapComponent

All Implemented Interfaces:

Locatable, LocationHolder, org.apache.tapestry.IComponent, org.apache.tapestry.IDirectEvent, org.apache.tapestry.internal.Component, org.apache.tapestry.IRender, org.apache.tapestry.ITemplateComponent

public abstract class SiteMapComponent
extends org.apache.tapestry.BaseComponent

Useful methods for generating a site map.

Author:

andyhot

Field Summary

Fields inherited from class org.apache.tapestry.AbstractComponent

_body, _bodyCount

Constructor Summary

SiteMapComponent()

Method Summary

abstract String	getCategory()
String	getCategoryClass() The css class to be applied for the currently rendering category.
String	getCategoryDisplayName() The display name for the currently rendering category.
CategoryInfo	getCategoryOf(String page) The category where the given page belongs.
CategoryInfo	getCurrentPageCategory() The category of the currently displaying page.
String	getDefaultPage() The default page for the currently rendering category.
abstract boolean	getIgnoreCurrentPage()
abstract String	getName()
String	getPageClass() The css class to be applied for the currently rendering page.
String	getPageDisplayName() The display name for the currently rendering page.
List	getPagesOfCategory(String category) Gets the pages of the given category.
List	getPagesOfCategoryOfCurrentPage() Gets the pages that belong to the same category as the currently displaying one.
List	getPagesOfCategoryOfPage(String page) Gets the pages that belong to the same category as the given one.
List	getPagesOfCurrentCategory() Gets the pages of the currently rendering category.
abstract boolean	getShowAll()
boolean	getShowPage()
boolean	getShowSiteMap() If the sitemap should be shown.
abstract SiteMap	getSiteMap()
boolean	isCurrentPageInCategory() If the currently displaying page is part of the currently rendering category.
boolean	isPageInCategory(String page) If the given page is part of the currently rendering category.

Methods inherited from class org.apache.tapestry.BaseComponent

addOuter, finishLoad, getContainedRenderers, getInnerRenderers, renderComponent

Methods inherited from class org.apache.tapestry.AbstractComponent

addAsset, addBody, addComponent, checkActiveLock, cleanupAfterRender, enterActiveState, equals, finishLoad, generateClientId, getAsset, getAssets, getBeans, getBinding, getBindingNames, getBindings, getBody, getBodyCount, getBoundId, getClientId, getComponent, getComponents, getContainedComponent, getContainer, getEventInvoker, getExtendedId, getId, getIdPath, getListeners, getMessages, getNamespace, getPage, getRenderWorker, getSpecification, getSpecifiedId, getTemplateTagName, hasEvents, hashCode, isInActiveState, isParameterBound, isRendering, isStateful, pageEndRender, peekClientId, prepareForRender, render, renderBody, renderIdAttribute, renderInformalParameters, setBinding, setClientId, setContainedComponent, setContainer, setHasEvents, setId, setNamespace, setPage, setTemplateTagName, toString, triggerEvent

Methods inherited from class org.apache.hivemind.impl.BaseLocatable

getLocation, setLocation

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.apache.tapestry.IComponent

addAsset, addBody, addComponent, enterActiveState, getAsset, getAssets, getBeans, getBinding, getBindingNames, getBindings, getClientId, getComponent, getComponents, getContainedComponent, getContainer, getEventInvoker, getExtendedId, getId, getIdPath, getListeners, getMessages, getNamespace, getPage, getSpecification, getSpecifiedId, getTemplateTagName, isRendering, peekClientId, renderBody, setBinding, setClientId, setContainedComponent, setContainer, setId, setNamespace, setPage, setTemplateTagName

Methods inherited from interface org.apache.tapestry.IRender

render

Methods inherited from interface org.apache.hivemind.LocationHolder

setLocation

Methods inherited from interface org.apache.hivemind.Locatable

getLocation

Constructor Detail

SiteMapComponent

public SiteMapComponent()

Method Detail

getSiteMap

public abstract SiteMap getSiteMap()

getName

public abstract String getName()

getCategory

public abstract String getCategory()

getShowAll

public abstract boolean getShowAll()

getIgnoreCurrentPage

public abstract boolean getIgnoreCurrentPage()

getShowSiteMap

public boolean getShowSiteMap()

If the sitemap should be shown.

getCategoryOf

public CategoryInfo getCategoryOf(String page)

The category where the given page belongs.

getCurrentPageCategory

public CategoryInfo getCurrentPageCategory()

The category of the currently displaying page.

isPageInCategory

public boolean isPageInCategory(String page)

If the given page is part of the currently rendering category.

isCurrentPageInCategory

public boolean isCurrentPageInCategory()

If the currently displaying page is part of the currently rendering category.

getDefaultPage

public String getDefaultPage()

The default page for the currently rendering category.

getCategoryClass

public String getCategoryClass()

The css class to be applied for the currently rendering category. It is 'current' if the category in question contains the displaying page.

getCategoryDisplayName

public String getCategoryDisplayName()

The display name for the currently rendering category.

getPageDisplayName

public String getPageDisplayName()

The display name for the currently rendering page.

getPagesOfCategoryOfPage

public List getPagesOfCategoryOfPage(String page)

Gets the pages that belong to the same category as the given one.

getPagesOfCategoryOfCurrentPage

public List getPagesOfCategoryOfCurrentPage()

Gets the pages that belong to the same category as the currently displaying one.

getPagesOfCategory

public List getPagesOfCategory(String category)

Gets the pages of the given category.

getPagesOfCurrentCategory

public List getPagesOfCurrentCategory()

Gets the pages of the currently rendering category.

getShowPage

public boolean getShowPage()

getPageClass

public String getPageClass()

The css class to be applied for the currently rendering page. It is 'here' if the page in question is in fact the one currently displayed.