com.aspose.tasks

Interfaces

Classes

Exceptions

Class BarStyle


  • public class BarStyle
    extends Object

    Change the visual style of the bar for the item in the project view.

    • Constructor Detail

      • BarStyle

        public BarStyle()

        Initializes a new instance of the BarStyle class.

    • Method Detail

      • getBarColor

        public final Color getBarColor()

        Gets Color of the bar style.

        Returns:
        a color of the bar style.
      • setBarColor

        public final void setBarColor​(Color value)

        Sets Color of the bar style.

        Parameters:
        value - a color of the bar style.
      • getBarShape

        public final int getBarShape()

        Gets bar shape (BarShape) of the bar style.

        Returns:
        bar shape of the bar style.
      • setBarShape

        public final void setBarShape​(int value)
        Sets bar shape (BarShape) of the bar style.
        Parameters:
        value - bar shape of the bar style.
      • getBarTextConverter

        @Deprecated
        public final BarStyle.TaskToBarTextConverter getBarTextConverter()
        Deprecated.
        This property is obsolete and will be removed after the release 21.10. Please use more specific *BarTextConverter properties instead.

        Gets converter to get text for the bar to render.


        String to render on the right of the bar.
        Returns:
        converter to get text for the bar to render.
      • setBarTextConverter

        @Deprecated
        public final void setBarTextConverter​(BarStyle.TaskToBarTextConverter value)
        Deprecated.
        This property is obsolete and will be removed after the release 21.10. Please use more specific *BarTextConverter properties instead.

        Sets converter to get text for the bar to render.


        String to render on the right of the bar.
        Parameters:
        value - converter to get text for the bar to render.
      • getBottomBarTextConverter

        public final TaskBarTextConverter getBottomBarTextConverter()

        Gets user-defined converter to get text to render on the bottom of the task's bar. Overrides the value of BottomField(getBottomField()/setBottomField(int)) property.

        Returns:
        user-defined converter to get text to render on the bottom of the task's bar.
      • setBottomBarTextConverter

        public final void setBottomBarTextConverter​(TaskBarTextConverter value)

        Sets user-defined converter to get text to render on the bottom of the task's bar. Overrides the value of BottomField(getBottomField()/setBottomField(int)) property.

        Parameters:
        value - user-defined converter to get text to render on the bottom of the task's bar.
      • getBottomField

        public final int getBottomField()

        Gets a field to be displayed on the bottom of the bar.

        Returns:
        a field to be displayed on the bottom of the bar.
      • setBottomField

        public final void setBottomField​(int value)

        Sets a field to be displayed on the bottom of the bar.

        Parameters:
        value - a field to be displayed on the bottom of the bar.
      • getEndShape

        public final int getEndShape()

        Gets Shape at the end of the bar.

        Returns:
        Shape at the end of the bar.
      • setEndShape

        public final void setEndShape​(int value)

        Sets Shape at the end of the bar.

        Parameters:
        value - Shape at the end of the bar.
      • getEndShapeColor

        public final Color getEndShapeColor()

        Gets Color of the shape at the end of the bar.

        Returns:
        a color of the shape at the beginning of the bar.
      • setEndShapeColor

        public final void setEndShapeColor​(Color value)

        Sets Color of the shape at the end of the bar.

        Parameters:
        value - a color of the shape at the beginning of the bar.
      • getInsideBarTextConverter

        public final TaskBarTextConverter getInsideBarTextConverter()

        Gets user-defined converter to get text to render inside of the task's bar. Overrides the value of InsideField(getInsideField()/setInsideField(int)) property.

        Returns:
        user-defined converter to get text to render inside of the task's bar.
      • setInsideBarTextConverter

        public final void setInsideBarTextConverter​(TaskBarTextConverter value)

        Sets user-defined converter to get text to render inside of the task's bar. Overrides the value of InsideField(getInsideField()/setInsideField(int)) property.

        Parameters:
        value - user-defined converter to get text to render inside of the task's bar.
      • getInsideField

        public final int getInsideField()

        Gets a field to be displayed inside of the bar.

        Returns:
        a field to be displayed inside of the bar.
      • setInsideField

        public final void setInsideField​(int value)

        Sets a field to be displayed inside of the bar.

        Parameters:
        value - a field to be displayed inside of the bar.
      • getItemType

        public final int getItemType()

        Gets BarItemType of the bar style.

        Returns:
        BarItemType of the bar style.
      • setItemType

        public final void setItemType​(int value)

        Sets BarItemType of the bar style.

        Parameters:
        value - BarItemType of the bar style.
      • getLeftBarTextConverter

        public final TaskBarTextConverter getLeftBarTextConverter()

        Gets user-defined converter to get text to render on the left of the task's bar. Overrides the value of LeftField(getLeftField()/setLeftField(int)) property.

        Returns:
        user-defined converter to get text to render on the left of the task's bar.
      • setLeftBarTextConverter

        public final void setLeftBarTextConverter​(TaskBarTextConverter value)

        Sets user-defined converter to get text to render on the left of the task's bar. Overrides the value of LeftField(getLeftField()/setLeftField(int)) property.

        Parameters:
        value - user-defined converter to get text to render on the left of the task's bar.
      • getLeftField

        public final int getLeftField()

        Gets a field to be displayed on the left of the bar.

        Returns:
        a field to be displayed on the left of the bar.
      • setLeftField

        public final void setLeftField​(int value)

        Sets a field to be displayed on the left of the bar.

        Parameters:
        value - a field to be displayed on the left of the bar.
      • getRightBarTextConverter

        public final TaskBarTextConverter getRightBarTextConverter()

        Gets user-defined converter to get text to render on the right of the task's bar. Overrides the value of RightField(getRightField()/setRightField(int)) property.

        Returns:
        user-defined converter to get text to render on the right of the task's bar.
      • setRightBarTextConverter

        public final void setRightBarTextConverter​(TaskBarTextConverter value)

        Sets user-defined converter to get text to render on the right of the task's bar. Overrides the value of RightField(getRightField()/setRightField(int)) property.

        Parameters:
        value - user-defined converter to get text to render on the right of the task's bar.
      • getRightField

        public final int getRightField()

        Gets a field to be displayed on the right of the bar.

        Returns:
        a field to be displayed on the right of the bar.
      • setRightField

        public final void setRightField​(int value)

        Sets a field to be displayed on the right of the bar.

        Parameters:
        value - a field to be displayed on the right of the bar.
      • getStartShape

        public final int getStartShape()

        Gets Shape at the beginning of the bar.

        Returns:
        Shape at the beginning of the bar.
      • setStartShape

        public final void setStartShape​(int value)

        Sets Shape at the beginning of the bar.

        Parameters:
        value - Shape at the beginning of the bar.
      • getStartShapeColor

        public final Color getStartShapeColor()

        Gets Color of the shape at the beginning of the bar.

        Returns:
        a color of the shape at the beginning of the bar.
      • setStartShapeColor

        public final void setStartShapeColor​(Color value)

        Sets Color of the shape at the beginning of the bar.

        Parameters:
        value - a color of the shape at the beginning of the bar.
      • getTextStyle

        public final TextStyle getTextStyle()

        Gets text style (TextStyle) of the text to render on the right of the bar.

        Returns:
        text style of the text to render on the right of the bar.
      • setTextStyle

        public final void setTextStyle​(TextStyle value)
        Sets text style (TextStyle) of the text to render on the right of the bar.
        Parameters:
        value - text style of the text to render on the right of the bar.
      • getTopBarTextConverter

        public final TaskBarTextConverter getTopBarTextConverter()

        Gets user-defined converter to get text to render on the top of the task's bar. Overrides the value of TopField(getTopField()/setTopField(int)) property.

        Returns:
        user-defined converter to get text to render on the top of the task's bar.
      • setTopBarTextConverter

        public final void setTopBarTextConverter​(TaskBarTextConverter value)

        Sets user-defined converter to get text to render on the top of the task's bar. Overrides the value of TopField(getTopField()/setTopField(int)) property.

        Parameters:
        value - user-defined converter to get text to render on the top of the task's bar.
      • getTopField

        public final int getTopField()

        Gets a field to be displayed on the top of the bar.

        Returns:
        a field to be displayed on the top of the bar.
      • setTopField

        public final void setTopField​(int value)

        Sets a field to be displayed on the top of the bar.

        Parameters:
        value - a field to be displayed on the top of the bar.