com.aspose.tasks

Interfaces

Classes

Exceptions

com.aspose.tasks

Class 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 and Description
      GroupCriterion() 
    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method and Description
      boolean getAscending()
      Returns true if a field used as a criterion in a group definition is sorted in ascending order.
      Color getCellColor()
      Gets a color of the cell background for a field used as a criterion in a group definition.
      int getField()
      Gets a field being grouped by.
      Font getFont()
      Gets a font used in group criterion.
      Color getFontColor()
      Gets a color of the font for a field used as a criterion in a group definition.
      Object getGroupInterval()
      Gets an 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 a GroupCriterion object in the containing GroupCriterionCollection collection.
      Group getParentGroup()
      Gets the parent of the GroupCriterion object.
      int getPattern()
      Gets a pattern of the cell for a field used as a criterion in a group definition.
      Object getStartAt()
      Gets a start of the intervals for a field used as a criterion in a group definition.
      void setAscending(boolean value)
      Set to true if a field used as a criterion in a group definition is sorted in ascending order.
      void setCellColor(Color value)
      Sets a color of the cell background for a field used as a criterion in a group definition.
      void setField(int value)
      Sets a field being grouped by.
      void setFont(Font value)
      Sets a font used in group criterion.
      void setFontColor(Color value)
      Sets a color of the font for a field used as a criterion in a group definition.
      void setGroupInterval(Object value)
      Sets an 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 a pattern of the cell for a field used as a criterion in a group definition.
      void setStartAt(Object value)
      Sets a start of the intervals for a field used as a criterion in a group definition.
    • Constructor Detail

      • GroupCriterion

        public GroupCriterion()
    • Method Detail

      • getAscending

        public boolean getAscending()

        Returns true if a field used as a criterion in a group definition is sorted in ascending order. False if the field is sorted in descending order. Read/write bool.

        Returns:
        true if a field used as a criterion in a group definition is sorted in ascending order; otherwise, false.
      • setAscending

        public void setAscending(boolean value)
        Set to true if 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 - true if a field used as a criterion in a group definition is sorted in ascending order; otherwise, false.
      • getCellColor

        public Color getCellColor()
        Gets a color of the cell background for a field used as a criterion in a group definition.
        Returns:
        a color of the cell background for a field used as a criterion in a group definition.
      • setCellColor

        public void setCellColor(Color value)
        Sets a color of the cell background for a field used as a criterion in a group definition.
        Parameters:
        value - a color of the cell background for a field used as a criterion in a group definition.
      • getFontColor

        public Color getFontColor()
        Gets a color of the font for a field used as a criterion in a group definition.
        Returns:
        a color of the font for a field used as a criterion in a group definition.
      • setFontColor

        public void setFontColor(Color value)
        Sets a color of the font for a field used as a criterion in a group definition.
        Parameters:
        value - a color of the font for a field used as a criterion in a group definition.
      • getField

        public int getField()

        Gets a field being grouped by. Read/write Field.

        Returns:
        a field being grouped by.
      • setField

        public void setField(int value)
        Sets a field being grouped by.
        Parameters:
        value - a field being grouped by.
      • getIndex

        public int getIndex()

        Gets the index of a GroupCriterion object in the containing GroupCriterionCollection collection. Read-only int.

        Returns:
        the index of group criterion in the containing group criteria collection.
      • getParentGroup

        public Group getParentGroup()

        Gets the parent of the GroupCriterion object. Read-only Group.

        Returns:
        parent group.
      • getGroupOn

        public int getGroupOn()

        Gets the type of grouping for a field used as a criterion in a group definition. Read/write GroupOn.

        Returns:
        GroupOn enumerated type value.
      • setGroupOn

        public void setGroupOn(int value)
        Sets the type of grouping for a field used as a criterion in a group definition.
        Parameters:
        value - GroupOn enumerated type value.
      • getPattern

        public int getPattern()

        Gets a pattern of the cell for a field used as a criterion in a group definition. Read/write BackgroundPattern.

        Returns:
        BackgroundPattern enumerated type value.
      • setPattern

        public void setPattern(int value)
        Sets a pattern of the cell for a field used as a criterion in a group definition.
        Parameters:
        value - BackgroundPattern enumerated type value.
      • getStartAt

        public Object getStartAt()

        Gets a start of the intervals for a field used as a criterion in a group definition. Read/write object.

        Returns:
        a start of the intervals for a field used as a criterion in a group definition.
      • setStartAt

        public void setStartAt(Object value)
        Sets a start of the intervals for a field used as a criterion in a group definition.
        Parameters:
        value - a start of the intervals for a field used as a criterion in a group definition.
      • getGroupInterval

        public Object getGroupInterval()

        Gets an interval for a field used as a criterion in a group definition. Read/write object.

        Returns:
        an interval for a field used as a criterion in a group definition.
      • setGroupInterval

        public void setGroupInterval(Object value)
        Sets an interval for a field used as a criterion in a group definition.
        Parameters:
        value - an interval for a field used as a criterion in a group definition.
      • getFont

        public Font getFont()
        Gets a font used in group criterion.
        Returns:
        a font used in group criterion.
      • setFont

        public void setFont(Font value)
        Sets a font used in group criterion.
        Parameters:
        value - a font used in group criterion.