Class GroupCriterion
- java.lang.Object
-
- com.aspose.tasks.GroupCriterion
-
public class GroupCriterion extends Object
Represents a criterion in a group definition. The GroupCriterion object is a member of the
GroupCriterionCollection
collection.
-
-
Constructor Summary
Constructors Constructor Description GroupCriterion()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description boolean
equals(Object obj)
Returns a value indicating whether this instance is equal to a specified object.boolean
getAscending()
Gets a value indicating whether a field used as a criterion in a group definition is sorted in ascending order.Color
getCellColor()
Gets the color of the cell background for a field used as a criterion in a group definition.int
getField()
Gets the field being grouped by.Font
getFont()
Gets the font for a criterion in a group definition.Color
getFontColor()
Gets the color of the font for a field used as a criterion in a group definition.Object
getGroupInterval()
Gets the interval for a field used as a criterion in a group definition.int
getGroupOn()
Gets the type of grouping for a field used as a criterion in a group definition.int
getIndex()
Gets the index of aGroupCriterion
object in the containingGroupCriterionCollection
collection.Group
getParentGroup()
Gets the parent of theGroupCriterion
object.int
getPattern()
Gets the pattern of the cell for a field used as a criterion in a group definition.Object
getStartAt()
Gets the start of the intervals for a field used as a criterion in a group definition.int
hashCode()
Serves as a hash function for a particular type.void
setAscending(boolean value)
Sets a value indicating whether a field used as a criterion in a group definition is sorted in ascending order.void
setCellColor(Color value)
Sets the color of the cell background for a field used as a criterion in a group definition.void
setField(int value)
Sets the field being grouped by.void
setFont(Font value)
Sets the font for a criterion in a group definition.void
setFontColor(Color value)
Sets the color of the font for a field used as a criterion in a group definition.void
setGroupInterval(Object value)
Sets the interval for a field used as a criterion in a group definition.void
setGroupOn(int value)
Sets the type of grouping for a field used as a criterion in a group definition.void
setPattern(int value)
Sets the pattern of the cell for a field used as a criterion in a group definition.void
setStartAt(Object value)
Sets the start of the intervals for a field used as a criterion in a group definition.
-
-
-
Method Detail
-
equals
public boolean equals(Object obj)
Returns a value indicating whether this instance is equal to a specified object.
-
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:
- a value indicating whether a field used as a criterion in a group definition is sorted in ascending order.
-
setAscending
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:
value
- 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:
- the color of the cell background for a field used as a criterion in a group definition.
-
setCellColor
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:
value
- 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:
- the field being grouped by.
-
setField
public final void setField(int value)
Sets the field being grouped by.
- Parameters:
value
- the field being grouped by.
-
getFont
public final Font getFont()
Gets the font for a criterion in a group definition.
- Returns:
- the font for a criterion in a group definition.
-
setFont
public final void setFont(Font value)
Sets the font for a criterion in a group definition.
- Parameters:
value
- 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:
- the color of the font for a field used as a criterion in a group definition.
-
setFontColor
public final void setFontColor(Color value)
Sets the color of the font for a field used as a criterion in a group definition.
- Parameters:
value
- 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:
- the interval for a field used as a criterion in a group definition.
-
setGroupInterval
public final void setGroupInterval(Object value)
Sets the interval for a field used as a criterion in a group definition.
- Parameters:
value
- 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:
- the type of grouping for a field used as a criterion in a group definition.
-
setGroupOn
public final void setGroupOn(int value)
Sets the type of grouping for a field used as a criterion in a group definition.
- Parameters:
value
- 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 containingGroupCriterionCollection
collection.- Returns:
- the index of a
GroupCriterion
object in the containingGroupCriterionCollection
collection.
-
getParentGroup
public final Group getParentGroup()
Gets the parent of the
GroupCriterion
object.- Returns:
- 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:
- the pattern of the cell for a field used as a criterion in a group definition.
-
setPattern
public final void setPattern(int value)
Sets the pattern of the cell for a field used as a criterion in a group definition.
- Parameters:
value
- 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:
- the start of the intervals for a field used as a criterion in a group definition.
-
setStartAt
public final void setStartAt(Object value)
Sets the start of the intervals for a field used as a criterion in a group definition.
- Parameters:
value
- the start of the intervals for a field used as a criterion in a group definition.
-
-