org.kuali.rice.krad.uif.util
Class PageBreadcrumbOptions

java.lang.Object
  org.kuali.rice.krad.uif.util.BreadcrumbOptions
      org.kuali.rice.krad.uif.util.PageBreadcrumbOptions

All Implemented Interfaces:

Serializable

public class PageBreadcrumbOptions
extends BreadcrumbOptions

BreadcrumbOptions specific to page. Render options are only available at the page level.

See Also:

Serialized Form

Constructor Summary

PageBreadcrumbOptions()

Method Summary

protected <T> void	copyProperties(T breadcrumbOptions) Copies the properties over for the copy method.
void	finalizeBreadcrumbs(View view, Object model, Container parent, BreadcrumbItem breadcrumbItem) Finalize the setup of the BreadcrumbOptions and the BreadcrumbItem for the PageGroup.
boolean	isRenderHomewardPathBreadcrumbs() If true, render the homewardPathBreadcrumbs (if any are set), otherwise do not render them
boolean	isRenderParentLocations() If true, render the parent location breadcrumbs.
boolean	isRenderPrePageBreadcrumbs() If true, render the prePageBreadcrumbs (if any are set), otherwise do not render them
boolean	isRenderPreViewBreadcrumbs() If true, render the preViewBreadcrumbs (if any are set), otherwise do not render them
boolean	isRenderViewBreadcrumb() Whether or not to render the view breadcrumb at this level
void	setRenderHomewardPathBreadcrumbs(boolean renderHomewardPathBreadcrumbs) Set renderHomewardPathBreadcrumbs
void	setRenderParentLocations(boolean renderParentLocations) Set renderParentLocations
void	setRenderPrePageBreadcrumbs(boolean renderPrePageBreadcrumbs) Set renderPrePageBreadcrumbs
void	setRenderPreViewBreadcrumbs(boolean renderPreViewBreadcrumbs) Set renderPreViewBreadcrumbs
void	setRenderViewBreadcrumb(boolean renderViewBreadcrumb) Set renderViewBreadcrumb
void	setupBreadcrumbs(View view, Object model) Setup the BreadcrumbOptions and BreadcrumbItem for a PageGroup.

Methods inherited from class org.kuali.rice.krad.uif.util.BreadcrumbOptions

copy, getBreadcrumbOverrides, getHomewardPathBreadcrumbs, getPrePageBreadcrumbs, getPreViewBreadcrumbs, setBreadcrumbOverrides, setHomewardPathBreadcrumbs, setPrePageBreadcrumbs, setPreViewBreadcrumbs

Methods inherited from class java.lang.Object

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

Constructor Detail

PageBreadcrumbOptions

public PageBreadcrumbOptions()

Method Detail

setupBreadcrumbs

public void setupBreadcrumbs(View view,
                             Object model)

Setup the BreadcrumbOptions and BreadcrumbItem for a PageGroup. To be called from performInitialization.

Overrides:

setupBreadcrumbs in class BreadcrumbOptions

Parameters:

view - the page's View

model - the model

finalizeBreadcrumbs

public void finalizeBreadcrumbs(View view,
                                Object model,
                                Container parent,
                                BreadcrumbItem breadcrumbItem)

Finalize the setup of the BreadcrumbOptions and the BreadcrumbItem for the PageGroup. To be called from the performFinalize method.

Overrides:

finalizeBreadcrumbs in class BreadcrumbOptions

Parameters:

view - the page's View

model - the model

isRenderViewBreadcrumb

public boolean isRenderViewBreadcrumb()

Whether or not to render the view breadcrumb at this level

Returns:

true if rendering the view breadcrumb, false otherwise

setRenderViewBreadcrumb

public void setRenderViewBreadcrumb(boolean renderViewBreadcrumb)

Set renderViewBreadcrumb

Parameters:

renderViewBreadcrumb -

isRenderHomewardPathBreadcrumbs

public boolean isRenderHomewardPathBreadcrumbs()

If true, render the homewardPathBreadcrumbs (if any are set), otherwise do not render them

Returns:

true if rendering homewardPathBreadcrumbs, false otherwise

setRenderHomewardPathBreadcrumbs

public void setRenderHomewardPathBreadcrumbs(boolean renderHomewardPathBreadcrumbs)

Set renderHomewardPathBreadcrumbs

Parameters:

renderHomewardPathBreadcrumbs -

isRenderPreViewBreadcrumbs

public boolean isRenderPreViewBreadcrumbs()

If true, render the preViewBreadcrumbs (if any are set), otherwise do not render them

Returns:

true if rendering preViewBreadcrumbs, false otherwise

setRenderPreViewBreadcrumbs

public void setRenderPreViewBreadcrumbs(boolean renderPreViewBreadcrumbs)

Set renderPreViewBreadcrumbs

Parameters:

renderPreViewBreadcrumbs -

isRenderPrePageBreadcrumbs

public boolean isRenderPrePageBreadcrumbs()

If true, render the prePageBreadcrumbs (if any are set), otherwise do not render them

Returns:

true if rendering prePageBreadcrumbs, false otherwise

setRenderPrePageBreadcrumbs

public void setRenderPrePageBreadcrumbs(boolean renderPrePageBreadcrumbs)

Set renderPrePageBreadcrumbs

Parameters:

renderPrePageBreadcrumbs -

isRenderParentLocations

public boolean isRenderParentLocations()

If true, render the parent location breadcrumbs. These BreadcrumbItems are automatically generated based on the view's parentLocation property settings by traversing parent views/pages or based on a history path.

Returns:

true if rendering the parent location breadcrumbs, false otherwise

setRenderParentLocations

public void setRenderParentLocations(boolean renderParentLocations)

Set renderParentLocations

Parameters:

renderParentLocations -

copyProperties

protected <T> void copyProperties(T breadcrumbOptions)

Copies the properties over for the copy method.

Overrides:

copyProperties in class BreadcrumbOptions

Parameters:

breadcrumbOptions - The BreadcrumbOptions to copy