com.technia.tvc.core.structure

Interface Expander

All Known Implementing Classes:

AbstractExpander

public interface Expander

An Expander is responsible for expanding and collapsing nodes in subclasses of ExpanderBasedStructureBean. Expander implementations should be agnostic about which StructureBean instance is using it, the main reason being that the expanders are shared between instances upon cloning and navigation. Plus, the expanders always have access to the current StructureBean in the methods defined in this interface. If a particular Expander is coupled with a particular StructureBean instance you need to take special precausions to avoid undesired behavior upon cloning and navigation from that instance.

Since:

2009.1.0

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	Expander.ExpandCtx Provides contextual information to the Expander when expanding and collapsing nodes.
static class	Expander.FilterMode Instances represents different filter modes.

Field Summary

Fields

Modifier and Type	Field and Description
static Expander.FilterMode	COMBINABLE Filters can be changed, you can combine multiple filters.
static Expander.FilterMode	FIXED Filters can't be changed.
static Expander.FilterMode	SINGLE Filters can be changed, but only one can be used at the time.

Method Summary

Modifier and Type	Method and Description
void	collapseNode(Expander.ExpandCtx ctx, StructureBeanNode node) Collapses a node.
void	expandNode(Expander.ExpandCtx ctx, StructureBeanNode node, int levels) Expands a node.
Expander.FilterMode	getFilterMode(ExpanderBasedStructureBean structure) Returns the filter mode.
boolean	isFullExpandSupported(ExpanderBasedStructureBean structure) Returns true if this expander allows full expand
boolean	isMultiLevelExpandSupported(ExpanderBasedStructureBean structure) Returns true if this expander allows multi-level expands.

Field Detail

FIXED

static final Expander.FilterMode FIXED

Filters can't be changed.

SINGLE

static final Expander.FilterMode SINGLE

Filters can be changed, but only one can be used at the time.

COMBINABLE

static final Expander.FilterMode COMBINABLE

Filters can be changed, you can combine multiple filters.

Method Detail

isFullExpandSupported

boolean isFullExpandSupported(ExpanderBasedStructureBean structure)

Returns true if this expander allows full expand

Parameters:

structure - The ExpanderBasedStructureBean.

Returns:

True if full expand is allowed.

isMultiLevelExpandSupported

boolean isMultiLevelExpandSupported(ExpanderBasedStructureBean structure)

Returns true if this expander allows multi-level expands.

Parameters:

structure - The ExpanderBasedStructureBean.

Returns:

True if multi-level expands are supported.

getFilterMode

Expander.FilterMode getFilterMode(ExpanderBasedStructureBean structure)

Returns the filter mode.

Parameters:

structure - The current structure

expandNode

void expandNode(Expander.ExpandCtx ctx,
                StructureBeanNode node,
                int levels)
         throws TVCException

Expands a node.

Parameters:

ctx - The context

node - The node to expand.

levels - The number of levels to expand the node, zero for full expansion.

Throws:

TVCException - If unable to expand the node.

collapseNode

void collapseNode(Expander.ExpandCtx ctx,
                  StructureBeanNode node)

Collapses a node.

Parameters:

ctx - The context.

node - The node to collapse.

Since:

2009.3