ilog.cpl.datasource.css

Interface IlpHierarchyAdapterCustomization

All Superinterfaces:

IlpAdapterCustomization

All Known Subinterfaces:

IlpAbstractTreeAdapterCustomization, IlpEquipmentAdapterCustomization, IlpNetworkAdapterCustomization

public interface IlpHierarchyAdapterCustomization
extends IlpAdapterCustomization

This interface externalizes the properties of an IlpAbstractHierarchyAdapter which can be configured using cascading style sheets.

An IlpAbstractHierarchyAdapter It can be configured like this in a CSS file:

 Adapter {
   expansionStrategyFactory: @+MyExpansionStrategyFactory;
   showOrigin:  true;
   origin[0]:   "ObjectID_A";
   origin[1]:   "ObjectID_B";
   origin[2]:   "ObjectID_C";
      :
      :
   acceptedClasses[0]: ilog.tgo.model.IltNetworkElement;
   acceptedClasses[1]: ilog.tgo.model.IltPort;
 }

 Subobject#MyExpansionStrategyFactory {
   class: custom.ExpansionStrategyFactory;
   adapter: @adapter;
 }
 

Since:

JViews 8.0

Method Summary

Modifier and Type	Method and Description
String[]	getAcceptedClasses() Returns the list of business classes that should be accepted by this adapter.
IlpExpansionStrategyFactory	getExpansionStrategyFactory() Returns the expansion strategy that will be used by the representation objects created by this adapter.
Object[]	getOrigin() Returns the list of origin identifiers.
boolean	isShowOrigin() Returns if the origins will be displayed or not in the component.

Methods inherited from interface ilog.cpl.datasource.css.IlpAdapterCustomization

getExcludedClasses, getFilter

Method Detail

getOrigin

Object[] getOrigin()

Returns the list of origin identifiers.

By default, the list is empty and the origins are not shown, which means that only the objects that do not have a parent are considered root objects.

In the case there are identifiers specified in the list:

• If the origins are shown (the property showOrigin is set to true), the objects whose identifiers are included in the origin list will be represented as root objects.
• If the origins are not shown (the property showOrigin is set to false), the objects whose parent identifiers are included in the origin list will be represented as root objects.

Note: This property can be customized using CSS, as illustrated below:

 Adapter {
   origins[0]: NE1;
   origins[1]: NE2;
 }
 

isShowOrigin

boolean isShowOrigin()

Returns if the origins will be displayed or not in the component.

In the case there are identifiers specified in the origin list:

• If the origins are shown (the property showOrigin is set to true), the objects whose identifiers are included in the origin list will be represented as root objects.
• If the origins are not shown (the property showOrigin is set to false), the objects whose parent identifiers are included in the origin list will be represented as root objects.

Note that, if you pass an empty list with showOrigin set to true, no object will be represented.

Note: This property can be customized using CSS, as illustrated below:

 Adapter {
   showOrigin: true;
 }
 

getExpansionStrategyFactory

IlpExpansionStrategyFactory getExpansionStrategyFactory()

Returns the expansion strategy that will be used by the representation objects created by this adapter. Changing the expansion strategy factory does not affect representation objects that were already created by this adapter.

Note: This property can be customized using CSS, as illustrated below:

 Adapter {
   expansionStrategyFactory: @+factoryDef;
 }
 Subobject#factoryDef {
   class: ...;
 }
 

getAcceptedClasses

String[] getAcceptedClasses()

Returns the list of business classes that should be accepted by this adapter.

By default, the list is empty. This means that all business objects will be converted to representation objects. However, this does not include the ones that do not match the current filter criteria. If you specify business classes in the list, only the business objects from the given classes or from one of its subclasses will be automatically filtered. Their representation will be created in the associated representation model.

This property can be customized using CSS, as illustrated below:

 Adapter {
   acceptedClasses[0]: "business class A";
   acceptedClasses[1]: "business class B";
 }