com.webmethods.portal.service.portlet.info

Interface IPortletPropertyGroupInfo

public interface IPortletPropertyGroupInfo

Property group information. Defined in the portlet descriptor as:

<!-- the groups tag defines the set of property groups that are used to logically divide the portlet properties into related buckets in the UI of the publish process and the properties page of the portlet. --> <groups> <group> <!-- the name tag defines the internal name of the property group --> <name>group1</name> <!-- the caption tag defines the text used in the UI for the property group --> <caption>Property Group 1</caption> </group> </groups>

Method Summary

Modifier and Type	Method and Description
String	getCaption() Returns the group caption
String	getName() Returns the name of the group
Iterator<IPortletPropertyInfo>	getPropertyInfos() Returns the portlet property infos as an iterator of IPortletPropertyInfo.
Iterator<IPortletPropertyInfo>	getPropertyInfos(int propertyType) Returns the portlet property infos as an iterator of IPortletPropertyInfo.
Iterator<IPortletPropertyInfo>	getPropertyInfos(IPortletPropertyListFilter filter) The same as getPropertyInfos(int) but allows to specify a custom filter for the properties.
boolean	isEmpty() Returns whether this group has no properties
boolean	isEmpty(int propertyType) Returns whether this group has no properties of the given type mask
boolean	isEmpty(IPortletPropertyListFilter filter) Returns whether this group has all properties filtered out

Method Detail

getName

String getName()

Returns the name of the group

Returns:

the name of the group

getCaption

String getCaption()

Returns the group caption

Returns:

the group caption

getPropertyInfos

Iterator<IPortletPropertyInfo> getPropertyInfos()

Returns the portlet property infos as an iterator of IPortletPropertyInfo.

Returns:

{Iterator} of IPortletPropertyInfo for portlet properties from this group

See Also:

IPortletPropertyInfo

getPropertyInfos

Iterator<IPortletPropertyInfo> getPropertyInfos(int propertyType)

Returns the portlet property infos as an iterator of IPortletPropertyInfo. You can specify a mask with property types that you would like to get back.

Parameters:

propertyType - the mask with the propety types that you'd like to get back

Returns:

iterator of IPortletPropertyInfo for portlet properties form this group

See Also:

IPortletPropertyInfo

getPropertyInfos

Iterator<IPortletPropertyInfo> getPropertyInfos(IPortletPropertyListFilter filter)

The same as getPropertyInfos(int) but allows to specify a custom filter for the properties.

Parameters:

filter - the filter implementation

See Also:

getPropertyInfos(int)

isEmpty

boolean isEmpty()

Returns whether this group has no properties

Returns:

true is the group has no properties

isEmpty

boolean isEmpty(int propertyType)

Returns whether this group has no properties of the given type mask

Returns:

true is the group has no properties of the given type mask

isEmpty

boolean isEmpty(IPortletPropertyListFilter filter)

Returns whether this group has all properties filtered out

Returns:

true is the group has no properties to satisfy the filter