Class BarStyle
- java.lang.Object
-
- com.aspose.tasks.BarStyle
-
public class BarStyle extends Object
Change the visual style of the bar for the item in the project view.
-
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description ColorgetBarColor()GetsColorof the bar style.intgetBarShape()TaskBarTextConvertergetBottomBarTextConverter()Gets user-defined converter to get text to render on the bottom of the task's bar.intgetBottomField()Gets a field to be displayed on the bottom of the bar.intgetEndShape()GetsShapeat the end of the bar.ColorgetEndShapeColor()GetsColorof the shape at the end of the bar.intgetEndShapeType()Gets a type of the end shape.intgetFrom()Gets a start point position of the gantt bar.TaskBarTextConvertergetInsideBarTextConverter()Gets user-defined converter to get text to render inside of the task's bar.intgetInsideField()Gets a field to be displayed inside of the bar.intgetItemType()GetsBarItemTypeof the bar style.TaskBarTextConvertergetLeftBarTextConverter()Gets user-defined converter to get text to render on the left of the task's bar.intgetLeftField()Gets a field to be displayed on the left of the bar.TaskBarTextConvertergetRightBarTextConverter()Gets user-defined converter to get text to render on the right of the task's bar.intgetRightField()Gets a field to be displayed on the right of the bar.intgetStartShape()GetsShapeat the beginning of the bar.ColorgetStartShapeColor()GetsColorof the shape at the beginning of the bar.intgetStartShapeType()Gets a type of the start shape.TextStylegetTextStyle()Gets style of the bar's text.intgetTo()Gets a finish point position of the gantt bar.TaskBarTextConvertergetTopBarTextConverter()Gets user-defined converter to get text to render on the top of the task's bar.intgetTopField()Gets a field to be displayed on the top of the bar.voidsetBarColor(Color value)SetsColorof the bar style.voidsetBarShape(int value)voidsetBottomBarTextConverter(TaskBarTextConverter value)Sets user-defined converter to get text to render on the bottom of the task's bar.voidsetBottomField(int value)Sets a field to be displayed on the bottom of the bar.voidsetEndShape(int value)SetsShapeat the end of the bar.voidsetEndShapeColor(Color value)SetsColorof the shape at the end of the bar.voidsetEndShapeType(int value)Sets a type of the end shape.voidsetFrom(int value)Sets a start point position of the gantt bar.voidsetInsideBarTextConverter(TaskBarTextConverter value)Sets user-defined converter to get text to render inside of the task's bar.voidsetInsideField(int value)Sets a field to be displayed inside of the bar.voidsetItemType(int value)SetsBarItemTypeof the bar style.voidsetLeftBarTextConverter(TaskBarTextConverter value)Sets user-defined converter to get text to render on the left of the task's bar.voidsetLeftField(int value)Sets a field to be displayed on the left of the bar.voidsetRightBarTextConverter(TaskBarTextConverter value)Sets user-defined converter to get text to render on the right of the task's bar.voidsetRightField(int value)Sets a field to be displayed on the right of the bar.voidsetStartShape(int value)SetsShapeat the beginning of the bar.voidsetStartShapeColor(Color value)SetsColorof the shape at the beginning of the bar.voidsetStartShapeType(int value)Sets a type of the start shape.voidsetTextStyle(TextStyle value)Sets style of the bar's text.voidsetTo(int value)Sets a finish point position of the gantt bar.voidsetTopBarTextConverter(TaskBarTextConverter value)Sets user-defined converter to get text to render on the top of the task's bar.voidsetTopField(int value)Sets a field to be displayed on the top of the bar.
-
-
-
Constructor Detail
-
BarStyle
public BarStyle()
Initializes a new instance of the
BarStyleclass.
-
-
Method Detail
-
getBarColor
public final Color getBarColor()
Gets
Colorof the bar style.- Returns:
- a color of the bar style.
-
setBarColor
public final void setBarColor(Color value)
Sets
Colorof the bar style.- Parameters:
value- a color of the bar style.
-
getBarShape
public final int getBarShape()
Gets
BarShape(getBarShape()/setBarShape(int)) of the bar style.- Returns:
BarShapeof the bar style.
-
setBarShape
public final void setBarShape(int value)
Sets
BarShape(getBarShape()/setBarShape(int)) of the bar style.- Parameters:
value-BarShapeof the bar style.
-
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
Shapeat the end of the bar.- Returns:
Shapeat the end of the bar.
-
setEndShape
public final void setEndShape(int value)
Sets
Shapeat the end of the bar.- Parameters:
value-Shapeat the end of the bar.
-
getEndShapeColor
public final Color getEndShapeColor()
Gets
Colorof 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
Colorof the shape at the end of the bar.- Parameters:
value- a color of the shape at the beginning of the bar.
-
getEndShapeType
public final int getEndShapeType()
Gets a type of the end shape.
GanttBarType.- Returns:
- a type of the end shape.
-
setEndShapeType
public final void setEndShapeType(int value)
Sets a type of the end shape.
GanttBarType.- Parameters:
value- a type of the end shape.
-
getFrom
public final int getFrom()
Gets a start point position of the gantt bar.
Field.- Returns:
- a start point position of the gantt bar.
-
setFrom
public final void setFrom(int value)
Sets a start point position of the gantt bar.
Field.- Parameters:
value- a start point position of the gantt 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
BarItemTypeof the bar style.- Returns:
BarItemTypeof the bar style.
-
setItemType
public final void setItemType(int value)
Sets
BarItemTypeof the bar style.- Parameters:
value-BarItemTypeof 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
Shapeat the beginning of the bar.- Returns:
Shapeat the beginning of the bar.
-
setStartShape
public final void setStartShape(int value)
Sets
Shapeat the beginning of the bar.- Parameters:
value-Shapeat the beginning of the bar.
-
getStartShapeColor
public final Color getStartShapeColor()
Gets
Colorof 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
Colorof the shape at the beginning of the bar.- Parameters:
value- a color of the shape at the beginning of the bar.
-
getStartShapeType
public final int getStartShapeType()
Gets a type of the start shape.
- Returns:
- a type of the start shape.
-
setStartShapeType
public final void setStartShapeType(int value)
Sets a type of the start shape.
- Parameters:
value- a type of the start shape.
-
getTextStyle
public final TextStyle getTextStyle()
Gets style of the bar's text.
- Returns:
- style of the bar's text.
-
setTextStyle
public final void setTextStyle(TextStyle value)
Sets style of the bar's text.
- Parameters:
value- style of the bar's text.
-
getTo
public final int getTo()
Gets a finish point position of the gantt bar.
- Returns:
- a finish point position of the gantt bar.
-
setTo
public final void setTo(int value)
Sets a finish point position of the gantt bar.
- Parameters:
value- a finish point position of the gantt 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.
-
-