info.aduna.gee.spectacle.gee
Interface CustomizingSectionRenderer

All Known Implementing Classes:

DefaultJitSectionRenderer, DefaultSectionRenderer

public interface CustomizingSectionRenderer

Subclasses of section renderer may require some "last minute" influence on the contents to be rendered in a section. When they implement CustomizingSectionRenderer, they will have access to the entity just before it is rendered. Note that this interface is checked for by RenderUtil only.

Method Summary

void	customizeOverviewEntity(Entity overviewEntity, boolean isLeaf) The overviewEntry is ready.
boolean	handleSection(String path, NavigationTree node, Entity overviewEntity) Handle the current section.

Method Detail

handleSection

boolean handleSection(String path,
                      NavigationTree node,
                      Entity overviewEntity)

Handle the current section.

Parameters:

path - The path of the current section, including the current chunk.

node - The current spot in the NavigationTree.

overviewEntity - The (proposed) overview entity.

Returns:

if true, the section is fully handled, no overview is generated,
if false, the section handling continues with the overview.

See Also:

SectionRenderer.getChannel()

customizeOverviewEntity

void customizeOverviewEntity(Entity overviewEntity,
                             boolean isLeaf)

The overviewEntry is ready. This is the last opportunity to change it or to change the section. Note that the section's name is overviewEntity.getDestination().

Parameters:

overviewEntity - the overview entity to be rendered in a section

isLeaf - if true, the section is a leaf, otherwise the section will have subsections