com.sapportals.wcm.service.propertystructure
Interface IStructuredGroup

[contained in: com.sap.km.cm.service.base.par - km.shared.service.propertystructure_api.jar]

public interface IStructuredGroup

Preconfigured structured group for displaying the properties of a resource.

Method Summary

java.lang.String	getLabel(java.util.Locale locale) Gets the label for the group.
IMetaGroup	getMetaGroup() Gets the meta group object for this structured group.
java.lang.String	getName() Gets the name of the structured group.
IStructuredGroupItemList	getOrderedItems() Gets all items of the structured group in their configured order.
IStructuredGroupRenderer	getRenderer() Gets the renderer of this structured group.
boolean	hasOrderedItems() Checks if the structured group has configured items.
boolean	hasRenderer() Checks if the structured group has a configured renderer.
boolean	isSingleFocusEnabled() Checks if the sub groups of this group (only one level) should be displayed in a way that always only one group is in the focus

Method Detail

getName

public java.lang.String getName()
                         throws PropertyStructureServiceException

Gets the name of the structured group.

Returns:

group name

getLabel

public java.lang.String getLabel(java.util.Locale locale)
                          throws PropertyStructureServiceException

Gets the label for the group.

Parameters:

locale - locale to determine the labels language

label - of the group, if no label is available the group name is returned

getOrderedItems

public IStructuredGroupItemList getOrderedItems()
                                         throws PropertyStructureServiceException

Gets all items of the structured group in their configured order. An item can be a IStructuredGroup or a IStructuredProperty.

Returns:

items of the structured group or null if no items are configured for this group

getMetaGroup

public IMetaGroup getMetaGroup()
                        throws PropertyStructureServiceException

Gets the meta group object for this structured group.

Returns:

meta group

getRenderer

public IStructuredGroupRenderer getRenderer()
                                     throws PropertyStructureServiceException

Gets the renderer of this structured group. If no renderer is configured for this group the default group renderer is returned.

Returns:

renderer or null if the configured renderer class could not be found and the renderer object could not be created

hasRenderer

public boolean hasRenderer()
                    throws PropertyStructureServiceException

Checks if the structured group has a configured renderer.

Returns:

true if the group has a renderer

hasOrderedItems

public boolean hasOrderedItems()
                        throws PropertyStructureServiceException

Checks if the structured group has configured items.

Returns:

true if the group has items

isSingleFocusEnabled

public boolean isSingleFocusEnabled()
                             throws PropertyStructureServiceException

Checks if the sub groups of this group (only one level) should be displayed in a way that always only one group is in the focus

Returns:

true if the sub groups should be rendered in single focus mode (e.g. as tab strip)