GroupCriterion

Inheritance: java.lang.Object

public class GroupCriterion

Represents a criterion in a group definition. The GroupCriterion object is a member of the GroupCriterionCollection collection.

Constructors

Constructor	Description
GroupCriterion()

Methods

Method	Description
equals(Object obj)	Returns a value indicating whether this instance is equal to a specified object.
getAscending()	Gets a value indicating whether a field used as a criterion in a group definition is sorted in ascending order.
getCellColor()	Gets the color of the cell background for a field used as a criterion in a group definition.
getField()	Gets the field being grouped by.
getFont()	Gets the font for a criterion in a group definition.
getFontColor()	Gets the color of the font for a field used as a criterion in a group definition.
getGroupInterval()	Gets the interval for a field used as a criterion in a group definition.
getGroupOn()	Gets the type of grouping for a field used as a criterion in a group definition.
getIndex()	Gets the index of a GroupCriterion object in the containing GroupCriterionCollection collection.
getParentGroup()	Gets the parent of the GroupCriterion object.
getPattern()	Gets the pattern of the cell for a field used as a criterion in a group definition.
getStartAt()	Gets the start of the intervals for a field used as a criterion in a group definition.
hashCode()	Serves as a hash function for a particular type.
setAscending(boolean value)	Sets a value indicating whether a field used as a criterion in a group definition is sorted in ascending order.
setCellColor(Color value)	Sets the color of the cell background for a field used as a criterion in a group definition.
setField(int value)	Sets the field being grouped by.
setFont(FontDescriptor value)	Sets the font for a criterion in a group definition.
setFontColor(Color value)	Sets the color of the font for a field used as a criterion in a group definition.
setGroupInterval(Object value)	Sets the interval for a field used as a criterion in a group definition.
setGroupOn(int value)	Sets the type of grouping for a field used as a criterion in a group definition.
setPattern(int value)	Sets the pattern of the cell for a field used as a criterion in a group definition.
setStartAt(Object value)	Sets the start of the intervals for a field used as a criterion in a group definition.

GroupCriterion()

public GroupCriterion()

equals(Object obj)

public boolean equals(Object obj)

Returns a value indicating whether this instance is equal to a specified object.

Parameters:

Parameter	Type	Description
obj	java.lang.Object	The object to compare with this instance.

Returns: boolean - True if o is a GroupCriterion that has the same UID value as this instance; otherwise, false.

getAscending()

public final boolean getAscending()

Gets a value indicating whether a field used as a criterion in a group definition is sorted in ascending order. False if the field is sorted in descending order.

Returns: boolean - a value indicating whether a field used as a criterion in a group definition is sorted in ascending order.

getCellColor()

public final Color getCellColor()

Gets the color of the cell background for a field used as a criterion in a group definition.

Returns: java.awt.Color - the color of the cell background for a field used as a criterion in a group definition.

getField()

public final int getField()

Gets the field being grouped by.

Returns: int - the field being grouped by.

getFont()

public final FontDescriptor getFont()

Gets the font for a criterion in a group definition.

Returns: FontDescriptor - the font for a criterion in a group definition.

getFontColor()

public final Color getFontColor()

Gets the color of the font for a field used as a criterion in a group definition.

Returns: java.awt.Color - the color of the font for a field used as a criterion in a group definition.

getGroupInterval()

public final Object getGroupInterval()

Gets the interval for a field used as a criterion in a group definition.

Returns: java.lang.Object - the interval for a field used as a criterion in a group definition.

getGroupOn()

public final int getGroupOn()

Gets the type of grouping for a field used as a criterion in a group definition.

Returns: int - the type of grouping for a field used as a criterion in a group definition.

getIndex()

public final int getIndex()

Gets the index of a GroupCriterion object in the containing GroupCriterionCollection collection.

Returns: int - the index of a GroupCriterion object in the containing GroupCriterionCollection collection.

getParentGroup()

public final Group getParentGroup()

Gets the parent of the GroupCriterion object.

Returns: Group - the parent of the GroupCriterion object.

getPattern()

public final int getPattern()

Gets the pattern of the cell for a field used as a criterion in a group definition.

Returns: int - the pattern of the cell for a field used as a criterion in a group definition.

getStartAt()

public final Object getStartAt()

Gets the start of the intervals for a field used as a criterion in a group definition.

Returns: java.lang.Object - the start of the intervals for a field used as a criterion in a group definition.

hashCode()

public int hashCode()

Serves as a hash function for a particular type.

Returns: int - A hash code for the current Object.

setAscending(boolean value)

public final void setAscending(boolean value)

Sets a value indicating whether a field used as a criterion in a group definition is sorted in ascending order. False if the field is sorted in descending order.

Parameters:

Parameter	Type	Description
value	boolean	a value indicating whether a field used as a criterion in a group definition is sorted in ascending order.

setCellColor(Color value)

public final void setCellColor(Color value)

Sets the color of the cell background for a field used as a criterion in a group definition.

Parameters:

Parameter	Type	Description
value	java.awt.Color	the color of the cell background for a field used as a criterion in a group definition.

setField(int value)

public final void setField(int value)

Sets the field being grouped by.

Parameters:

Parameter	Type	Description
value	int	the field being grouped by.

setFont(FontDescriptor value)

public final void setFont(FontDescriptor value)

Sets the font for a criterion in a group definition.

Parameters:

Parameter	Type	Description
value	FontDescriptor	the font for a criterion in a group definition.

setFontColor(Color value)

public final void setFontColor(Color value)

Sets the color of the font for a field used as a criterion in a group definition.

Parameters:

Parameter	Type	Description
value	java.awt.Color	the color of the font for a field used as a criterion in a group definition.

setGroupInterval(Object value)

public final void setGroupInterval(Object value)

Sets the interval for a field used as a criterion in a group definition.

Parameters:

Parameter	Type	Description
value	java.lang.Object	the interval for a field used as a criterion in a group definition.

setGroupOn(int value)

public final void setGroupOn(int value)

Sets the type of grouping for a field used as a criterion in a group definition.

Parameters:

Parameter	Type	Description
value	int	the type of grouping for a field used as a criterion in a group definition.

setPattern(int value)

public final void setPattern(int value)

Sets the pattern of the cell for a field used as a criterion in a group definition.

Parameters:

Parameter	Type	Description
value	int	the pattern of the cell for a field used as a criterion in a group definition.

setStartAt(Object value)

public final void setStartAt(Object value)

Sets the start of the intervals for a field used as a criterion in a group definition.

Parameters:

Parameter	Type	Description
value	java.lang.Object	the start of the intervals for a field used as a criterion in a group definition.