Class GanttBarStyle
- java.lang.Object
-
- com.aspose.tasks.GanttBarStyle
-
public class GanttBarStyle extends Object
Represents a bar style used by MSP in Gantt Chart view.
-
-
Constructor Summary
Constructors Constructor Description GanttBarStyle()
Initializes a new instance of theGanttBarStyle
class.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description TaskBarTextConverter
getBottomBarTextConverter()
Gets user-defined converter to get text to render on the bottom of the task's bar.int
getBottomField()
Gets data to be displayed on the bottom of the bar.int
getEndShape()
Gets an end shape of the bar.Color
getEndShapeColor()
Gets a color of the end shape.int
getEndShapeType()
Gets a type of the end shape.int
getFrom()
Gets a start point position of the gantt bar.TaskBarTextConverter
getInsideBarTextConverter()
Gets user-defined converter to get text to render inside of the task's bar.int
getInsideField()
Gets data to be displayed inside of the bar.TaskBarTextConverter
getLeftBarTextConverter()
Gets user-defined converter to get text to render on the left of the task's bar.int
getLeftField()
Gets data to be displayed on the left of the bar.int
getMiddleFillPattern()
Gets a fill pattern of the gantt bar.int
getMiddleShape()
Gets a middle shape of the bar.Color
getMiddleShapeColor()
Gets a color of the middle shape.String
getName()
Gets a name of the style.GanttBarStyle
getParentStyle()
Gets parent (or common) style for custom task-specific style.TaskBarTextConverter
getRightBarTextConverter()
Gets user-defined converter to get text to render on the right of the task's bar.int
getRightField()
Gets data to be displayed on the right of the bar.int
getRow()
Gets a row number.List<Integer>
getShowForCategories()
Gets task categories for which the style is applied.Integer
getShowForTaskUid()
Gets Unique Id of a task for which the style is applied.int
getStartShape()
Gets a start shape of the bar.Color
getStartShapeColor()
Gets a color of the start shape.int
getStartShapeType()
Gets a type of the start shape.int
getTo()
Gets a finish point position of the gantt bar.TaskBarTextConverter
getTopBarTextConverter()
Gets user-defined converter to get text to render on the top of the task's bar.int
getTopField()
Gets data to be displayed on the top of the bar.void
setBottomBarTextConverter(TaskBarTextConverter value)
Sets user-defined converter to get text to render on the bottom of the task's bar.void
setBottomField(int value)
Sets data to be displayed on the bottom of the bar.void
setEndShape(int value)
Sets an end shape of the bar.void
setEndShapeColor(Color value)
Sets a color of the end shape.void
setEndShapeType(int value)
Sets a type of the end shape.void
setFrom(int value)
Sets a start point position of the gantt bar.void
setInsideBarTextConverter(TaskBarTextConverter value)
Sets user-defined converter to get text to render inside of the task's bar.void
setInsideField(int value)
Sets data to be displayed inside of the bar.void
setLeftBarTextConverter(TaskBarTextConverter value)
Sets user-defined converter to get text to render on the left of the task's bar.void
setLeftField(int value)
Sets data to be displayed on the left of the bar.void
setMiddleFillPattern(int value)
Sets a fill pattern of the gantt bar.void
setMiddleShape(int value)
Sets a middle shape of the bar.void
setMiddleShapeColor(Color value)
Sets a color of the middle shape.void
setName(String value)
Sets a name of the style.void
setParentStyle(GanttBarStyle value)
Sets parent (or common) style for custom task-specific style.void
setRightBarTextConverter(TaskBarTextConverter value)
Sets user-defined converter to get text to render on the right of the task's bar.void
setRightField(int value)
Sets data to be displayed on the right of the bar.void
setRow(int value)
Sets a row number.void
setShowForCategories(List<Integer> value)
Sets task categories for which the style is applied.void
setShowForTaskUid(Integer value)
Sets Unique Id of a task for which the style is applied.void
setStartShape(int value)
Sets a start shape of the bar.void
setStartShapeColor(Color value)
Sets a color of the start shape.void
setStartShapeType(int value)
Sets a type of the start shape.void
setTo(int value)
Sets a finish point position of the gantt bar.void
setTopBarTextConverter(TaskBarTextConverter value)
Sets user-defined converter to get text to render on the top of the task's bar.void
setTopField(int value)
Sets data to be displayed on the top of the bar.
-
-
-
Constructor Detail
-
GanttBarStyle
public GanttBarStyle()
Initializes a new instance of the
GanttBarStyle
class.
-
-
Method Detail
-
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.
Is not persisted to MPP format.- 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.
Is not persisted to MPP format.- Parameters:
value
- user-defined converter to get text to render on the bottom of the task's bar.
-
getBottomField
public final int getBottomField()
Gets data to be displayed on the bottom of the bar.
Field
.- Returns:
- data to be displayed on the bottom of the bar.
-
setBottomField
public final void setBottomField(int value)
Sets data to be displayed on the bottom of the bar.
Field
.- Parameters:
value
- data to be displayed on the bottom of the bar.
-
getEndShape
public final int getEndShape()
Gets an end shape of the bar.
- Returns:
- an end shape of the bar.
-
setEndShape
public final void setEndShape(int value)
Sets an end shape of the bar.
- Parameters:
value
- an end shape of the bar.
-
getEndShapeColor
public final Color getEndShapeColor()
Gets a color of the end shape.
- Returns:
- a color of the end shape.
-
setEndShapeColor
public final void setEndShapeColor(Color value)
Sets a color of the end shape.
- Parameters:
value
- a color of the end shape.
-
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.
Is not persisted to MPP format.- 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.
Is not persisted to MPP format.- Parameters:
value
- user-defined converter to get text to render inside of the task's bar.
-
getInsideField
public final int getInsideField()
Gets data to be displayed inside of the bar.
Field
.- Returns:
- data to be displayed inside of the bar.
-
setInsideField
public final void setInsideField(int value)
Sets data to be displayed inside of the bar.
Field
.- Parameters:
value
- data to be displayed inside of the bar.
-
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.
Is not persisted to MPP format.- 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.
Is not persisted to MPP format.- Parameters:
value
- user-defined converter to get text to render on the left of the task's bar.
-
getLeftField
public final int getLeftField()
Gets data to be displayed on the left of the bar.
Field
.- Returns:
- data to be displayed on the left of the bar.
-
setLeftField
public final void setLeftField(int value)
Sets data to be displayed on the left of the bar.
Field
.- Parameters:
value
- data to be displayed on the left of the bar.
-
getMiddleFillPattern
public final int getMiddleFillPattern()
Gets a fill pattern of the gantt bar.
- Returns:
- a fill pattern of the gantt bar.
-
setMiddleFillPattern
public final void setMiddleFillPattern(int value)
Sets a fill pattern of the gantt bar.
- Parameters:
value
- a fill pattern of the gantt bar.
-
getMiddleShape
public final int getMiddleShape()
Gets a middle shape of the bar.
- Returns:
- a middle shape of the bar.
-
setMiddleShape
public final void setMiddleShape(int value)
Sets a middle shape of the bar.
- Parameters:
value
- a middle shape of the bar.
-
getMiddleShapeColor
public final Color getMiddleShapeColor()
Gets a color of the middle shape.
- Returns:
- a color of the middle shape.
-
setMiddleShapeColor
public final void setMiddleShapeColor(Color value)
Sets a color of the middle shape.
- Parameters:
value
- a color of the middle shape.
-
getName
public final String getName()
Gets a name of the style.
- Returns:
- a name of the style.
-
setName
public final void setName(String value)
Sets a name of the style.
- Parameters:
value
- a name of the style.
-
getParentStyle
public final GanttBarStyle getParentStyle()
Gets parent (or common) style for custom task-specific style.
Task can have multiple custom styles with different parent styles. For example consider task having custom style with "Critical" parent style and another style with "Normal" parent style. Simply put, if task is critical, the first style is applied. If task becomes non-critical, the second style is applied (this logic is inherited from Microsoft Project Professional).- Returns:
- parent (or common) style for custom task-specific style.
-
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.
Is not persisted to MPP format.- 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.
Is not persisted to MPP format.- Parameters:
value
- user-defined converter to get text to render on the right of the task's bar.
-
getRightField
public final int getRightField()
Gets data to be displayed on the right of the bar.
Field
.- Returns:
- data to be displayed on the right of the bar.
-
setRightField
public final void setRightField(int value)
Sets data to be displayed on the right of the bar.
Field
.- Parameters:
value
- data to be displayed on the right of the bar.
-
getRow
public final int getRow()
Gets a row number.
Can be from 1 to 4 (1 is default value).- Returns:
- a row number.
-
setRow
public final void setRow(int value)
Sets a row number.
Can be from 1 to 4 (1 is default value).- Parameters:
value
- a row number.
-
getShowForCategories
public final List<Integer> getShowForCategories()
Gets task categories for which the style is applied. Is applicable for parent (or common) styles of bars in Gantt chart (see
GanttChartView.BarStyles
(GanttChartView.getBarStyles()
)).- Returns:
- task categories for which the style is applied.
-
setShowForCategories
public final void setShowForCategories(List<Integer> value)
Sets task categories for which the style is applied. Is applicable for parent (or common) styles of bars in Gantt chart (see
GanttChartView.BarStyles
(GanttChartView.getBarStyles()
)).- Parameters:
value
- task categories for which the style is applied.
-
getShowForTaskUid
public final Integer getShowForTaskUid()
Gets Unique Id of a task for which the style is applied. Is applicable for task-specific styles of bars in Gantt chart (see
GanttChartView.CustomBarStyles
(GanttChartView.getCustomBarStyles()
)).- Returns:
- Unique Id of a task for which the style is applied.
-
setShowForTaskUid
public final void setShowForTaskUid(Integer value)
Sets Unique Id of a task for which the style is applied. Is applicable for task-specific styles of bars in Gantt chart (see
GanttChartView.CustomBarStyles
(GanttChartView.getCustomBarStyles()
)).- Parameters:
value
- Unique Id of a task for which the style is applied.
-
getStartShape
public final int getStartShape()
Gets a start shape of the bar.
- Returns:
- a start shape of the bar.
-
setStartShape
public final void setStartShape(int value)
Sets a start shape of the bar.
- Parameters:
value
- a start shape of the bar.
-
getStartShapeColor
public final Color getStartShapeColor()
Gets a color of the start shape.
- Returns:
- a color of the start shape.
-
setStartShapeColor
public final void setStartShapeColor(Color value)
Sets a color of the start shape.
- Parameters:
value
- a color of the start shape.
-
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.
-
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.
Is not persisted to MPP format.- 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.
Is not persisted to MPP format.- Parameters:
value
- user-defined converter to get text to render on the top of the task's bar.
-
getTopField
public final int getTopField()
Gets data to be displayed on the top of the bar.
- Returns:
- data to be displayed on the top of the bar.
-
setTopField
public final void setTopField(int value)
Sets data to be displayed on the top of the bar.
- Parameters:
value
- data to be displayed on the top of the bar.
-
setParentStyle
public final void setParentStyle(GanttBarStyle value)
Sets parent (or common) style for custom task-specific style.
Task can have multiple custom styles with different parent styles. For example consider task having custom style with "Critical" parent style and another style with "Normal" parent style. Simply put, if task is critical, the first style is applied. If task becomes non-critical, the second style is applied (this logic is inherited from Microsoft Project Professional).- Parameters:
value
- parent (or common) style for custom task-specific style.
-
-