public class

BlockPropertyAnnotationGroups

extends Object
java.lang.Object
   ↳ com.microstrategy.web.blocks.BlockPropertyAnnotationGroups

Class Overview

This class holds a collections of annotation groups. A BlockProperty can hold any number of annotations, organized into named groups. These annotations are used by downstream tools (typically renderers). An annotation will not affect the way that a BlockProperty stores a value. Syntactically, any number of annotation groups can be specified, separating each by spaces.

Summary

Public Methods
BlockPropertyAnnotationGroup getGroup(String groupName, boolean create)
Returns the annotation group with the specified name.
BlockPropertyAnnotationGroup getGroup(int index)
Returns the annotation group at the specified index.
boolean hasGroup(String groupName)
Returns whether there is a group with the supplied name.
int numGroups()
Returns the number of annotation groups.
[Expand]
Inherited Methods
From class java.lang.Object

Public Methods

public BlockPropertyAnnotationGroup getGroup (String groupName, boolean create)

Returns the annotation group with the specified name.

Parameters
groupName The name of the annotation group to return.
create If the annotation does not exist, then this parameter indicates whether one should be created.
Returns
  • The BlockPropertyAnnotationGroup with the specified name (or a new one if 'create' is true) or null if no annotation group exists with the supplied name (and 'create' is false).

public BlockPropertyAnnotationGroup getGroup (int index)

Returns the annotation group at the specified index.

Parameters
index The index of the annotation group to return.
Returns
Throws
IllegalArgumentException is thrown if there is no annotation group at this index.

public boolean hasGroup (String groupName)

Returns whether there is a group with the supplied name.

Parameters
groupName The name of the group.
Returns
  • True if there is an annotation group with this name.

public int numGroups ()

Returns the number of annotation groups.

Returns