ilog.cpl.tree
Class IlpDefaultTreeExpansionStrategyFactory

java.lang.Object
  ilog.cpl.tree.IlpDefaultTreeExpansionStrategyFactory

All Implemented Interfaces:

IlpExpansionStrategyFactory

public class IlpDefaultTreeExpansionStrategyFactory
extends Object
implements IlpExpansionStrategyFactory

This class models a default expansion strategy factory for tree components.

This factory returns specific expansion strategies according to the value of the CSS property expansion in the different business objects. Expansion strategies are shared among all objects with a certain expansion type.

By default, the following expansion types are supported:

• IN_PLACE: Loads the children objects on demand, as the user expands the parent tree node. In this expansion strategy, tree nodes are considered as parent nodes, only when they have containment relationships. These relationships are defined in the attached data source through its IlpContainer interface. The children objects should already be loaded in the data source, and should be visible according to the data source filter, if there is one defined.
• IN_PLACE_MINIMAL_LOADING: Loads the children objects on demand, as the user expands the parent tree node. All tree nodes with this expansion strategy are considered as possible parent nodes, and are represented with an expansion icon. If the tree node does not contain children objects, the expansion icon will disappear when the expansion is executed for the first time.
• NO_EXPANSION: Expansion is not supported by the tree node.

Since:

JTGO 4.0

See Also:

IlpContainer, IlpAbstractHierarchyAdapter.setExpansionStrategyFactory(ilog.cpl.util.IlpExpansionStrategyFactory)

Field Summary

protected IlpExpansionStrategy	inPlaceExpansionStrategy Expansion strategy for IN_PLACE expansion
protected IlpExpansionStrategy	inPlaceMinimalLoadingExpansionStrategy Expansion strategy for IN_PLACE_MINIMAL_LOADING expansion

Fields inherited from interface ilog.cpl.util.IlpExpansionStrategyFactory

DEFAULT

Constructor Summary

IlpDefaultTreeExpansionStrategyFactory(IlpAbstractTreeAdapter adapter)
Creates an expansion strategy factory for the given adapter.

Method Summary

IlpExpansionStrategy	create(IlpObject ilpObject) Creates an expansion strategy that will be used by the representation object that corresponds to the given business object.
IlpAbstractTreeAdapter	getAdapter() Returns the adapter that is associated with this expansion strategy factory.

Methods inherited from class java.lang.Object

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

Field Detail

inPlaceMinimalLoadingExpansionStrategy

protected IlpExpansionStrategy inPlaceMinimalLoadingExpansionStrategy

Expansion strategy for IN_PLACE_MINIMAL_LOADING expansion

inPlaceExpansionStrategy

protected IlpExpansionStrategy inPlaceExpansionStrategy

Expansion strategy for IN_PLACE expansion

Constructor Detail

IlpDefaultTreeExpansionStrategyFactory

public IlpDefaultTreeExpansionStrategyFactory(IlpAbstractTreeAdapter adapter)

Creates an expansion strategy factory for the given adapter.

Parameters:

adapter - Tree adapter.

Since:

JTGO 4.0

Method Detail

getAdapter

public IlpAbstractTreeAdapter getAdapter()

Returns the adapter that is associated with this expansion strategy factory.

Since:

JTGO 4.0

create

public IlpExpansionStrategy create(IlpObject ilpObject)

Creates an expansion strategy that will be used by the representation object that corresponds to the given business object.

An expansion strategy defines how the representation object behaves in the component when it is collapsed or expanded.

This method returns a predefined expansion strategy according to the object expansion type:

• IN_PLACE: Loads the children objects on demand, as the user expands the parent tree node. In this expansion strategy, tree nodes are considered as parent nodes, only when they have containment relationships. These relationships are defined in the attached data source, through its IlpContainer interface. The children objects should already be loaded in the data source, and should be visible according to the data source filter, if there is one defined.
• IN_PLACE_MINIMAL_LOADING: Loads the children objects on demand, as the user expands the parent tree node. All tree nodes with this expansion strategy are considered as possible parent nodes, and are represented with an expansion icon. If the tree node does not contain children objects, the expansion icon will disappear when the expansion is executed for the first time.
• NO_EXPANSION: Expansion is not supported by the tree node.

The business object expansion type is customized in the tree adapter using cascading style sheets (CSS). The following example illustrates this customization:

     object {
       expansion: NO_EXPANSION;
     }
 

Expansion strategies are shared among business objects that share the same expansion type.

Specified by:

create in interface IlpExpansionStrategyFactory

Parameters:

ilpObject - Business object

Since:

JTGO 4.0

See Also:

IlpAbstractTreeAdapter.getExpansionType(ilog.cpl.model.IlpObject), IlpAbstractTreeAdapter.setStyleSheets(java.lang.String[]), IlpExpansionType, IlpExpansionStrategy