Skip navigation links

oracle.adf.view.faces.bi.component.gantt
Class TaskbarFormat

java.lang.Object
oracle.adf.view.faces.bi.component.gantt.TaskbarFormat

All Implemented Interfaces:

java.io.Serializable

public class TaskbarFormat

extends java.lang.Object

implements java.io.Serializable

A TaskbarFormat contains information about the appearance of a task bar. Application developers could specify the appearance of a new task type or modify the appearance of an existing task type by registering the TaskbarFormat with the TaskbarFormatManager.

See Also:

Serialized Form

Constructor Summary

TaskbarFormat(java.lang.String label, java.lang.String styleClass, boolean isStacked)
Constructs an instance of a TaskbarFormat for Resource Utilization Gantt using style class.

TaskbarFormat(java.lang.String label, java.lang.String image, int height)
Constructs an instance of a TaskbarFormat without style class.

TaskbarFormat(java.lang.String label, java.lang.String styleClass, java.lang.String startupStyleClass)
Constructs an instance of a TaskbarFormat for Scheduling Gantt using style class.

TaskbarFormat(java.lang.String label, java.lang.String leftStyleClass, java.lang.String middleStyleClass, java.lang.String rightStyleClass)
Constructs an instance of a TaskbarFormat for Project Gantt using style class.

TaskbarFormat(java.lang.String label, java.lang.String fillColor, java.lang.String fillImagePattern, java.lang.String borderColor, boolean isStacked)
Constructs an instance of a TaskbarFormat for Resource Utilization Gantt.

TaskbarFormat(java.lang.String label, java.lang.String fillColor, java.lang.String fillImagePattern, java.lang.String borderColor, int height)
Constructs an instance of a TaskbarFormat without style class.

TaskbarFormat(java.lang.String label, java.lang.String leftImage, java.lang.String rightImage, java.lang.String fillColor, java.lang.String fillImagePattern, java.lang.String borderColor, int height)
Constructs an instance of a TaskbarFormat without style class.

Method Summary

java.lang.String	getBorderColor()
java.lang.String	getFillColor()
java.lang.String	getFillImagePattern()
int	getHeight()
java.lang.String	getImage()
static TaskbarFormat	getInstance(java.lang.String label, java.lang.String format) Retrieve the task bar format based on a pre-defined format.
java.lang.String	getLabel()
java.lang.String	getLabelColor() Gets the color used for the label.
java.lang.String	getLabelStyleClass()
java.lang.String	getLeftImage()
int	getLeftShapeOffset() Retrieves the offset of the left image/style if specified relative to the start of the bar.
java.lang.String	getLeftStyleClass()
java.lang.String	getLinker()
java.lang.String	getMiddleStyleClass()
java.lang.String	getName() Retrieves the name associated with this format.
java.lang.String	getRightImage()
int	getRightShapeOffset() Retrieves the offset of the right image/style if specified relative to the end of the bar.
java.lang.String	getRightStyleClass()
java.lang.String	getStartupStyleClass()
java.lang.String	getStyleClass()
int	getWidth() Gets the width of the resource utilization bar.
boolean	isStacked() Determine whether the task bar is stack on top of the previous one.
void	setBorderColor(java.lang.String borderColor)
void	setFillColor(java.lang.String fillColor)
void	setHeight(int height)
void	setLabel(java.lang.String label) Specifies the label associated with this TaskbarFormat.
void	setLabelColor(java.lang.String color) Sets the color used for the label.
void	setLabelStyleClass(java.lang.String styleClass)
void	setLeftShapeOffset(int offset) Specify the offset of the left image/style if specified relative to the start of the bar.
void	setLinker(java.lang.String linker)
void	setRightShapeOffset(int offset) Specify the offset of the right image/style if specified relative to the end of the bar.
void	setStacked(boolean stacked) Specifies whether the task bar should be stack on top of the previous one.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

TaskbarFormat

public TaskbarFormat(java.lang.String label,
                     java.lang.String styleClass,
                     boolean isStacked)

Constructs an instance of a TaskbarFormat for Resource Utilization Gantt using style class.

TaskbarFormat

public TaskbarFormat(java.lang.String label,
                     java.lang.String fillColor,
                     java.lang.String fillImagePattern,
                     java.lang.String borderColor,
                     boolean isStacked)

Constructs an instance of a TaskbarFormat for Resource Utilization Gantt.

TaskbarFormat

public TaskbarFormat(java.lang.String label,
                     java.lang.String styleClass,
                     java.lang.String startupStyleClass)

Constructs an instance of a TaskbarFormat for Scheduling Gantt using style class.

Parameters:

label - The label associated with this TaskbarFormat.

styleClass - the style class.

startupStyleClass - the style class for the startup portion of a task bar.

TaskbarFormat

public TaskbarFormat(java.lang.String label,
                     java.lang.String leftStyleClass,
                     java.lang.String middleStyleClass,
                     java.lang.String rightStyleClass)

Constructs an instance of a TaskbarFormat for Project Gantt using style class.

Parameters:

label - The label associated with this TaskbarFormat.

leftStyleClass - the style class for the left portion of a task bar.

middleStyleClass - the style class for the middle portion of a task bar.

rightStyleClass - the style class for the right portion of a task bar.

TaskbarFormat

public TaskbarFormat(java.lang.String label,
                     java.lang.String fillColor,
                     java.lang.String fillImagePattern,
                     java.lang.String borderColor,
                     int height)

Constructs an instance of a TaskbarFormat without style class.

Parameters:

label - The label associated with this TaskbarFormat.

fillColor - The fill color of the task bar.

fillImagePattern - The image pattern used to fill the task bar.

borderColor - The border color of the task bar.

height - The height of the task bar.

TaskbarFormat

public TaskbarFormat(java.lang.String label,
                     java.lang.String image,
                     int height)

Constructs an instance of a TaskbarFormat without style class. This constructor is specifically used for Milestone task type.

Parameters:

label - The label associated with this TaskbarFormat.

image - The image used to display a milestone.

height - The height of the image.

TaskbarFormat

public TaskbarFormat(java.lang.String label,
                     java.lang.String leftImage,
                     java.lang.String rightImage,
                     java.lang.String fillColor,
                     java.lang.String fillImagePattern,
                     java.lang.String borderColor,
                     int height)

Constructs an instance of a TaskbarFormat without style class. This constructor is specifically used for Summary task type.

Parameters:

label - The label associated with this TaskbarFormat.

leftImage - The image used to display the left corner of a summary task bar.

rightImage - The image used to display the right corner of a summary task bar.

fillColor - The fill color of the task bar.

fillImagePattern - The image pattern used to fill the task bar.

borderColor - The border color of the task bar.

height - The height of the task bar.

Method Detail

getInstance

public static TaskbarFormat getInstance(java.lang.String label,
                                        java.lang.String format)

Retrieve the task bar format based on a pre-defined format.

Parameters:

label - The label associated with this TaskbarFormat.

format - The predefined format.

Returns:

getName

public java.lang.String getName()

Retrieves the name associated with this format. If you use getInstance to retrieve a predefined TaskbarFormat, that instance would have a name associated with it.

Returns:

the name of the format.

getLabelColor

public java.lang.String getLabelColor()

Gets the color used for the label. Default color is black.

setLabelColor

public void setLabelColor(java.lang.String color)

Sets the color used for the label.

getLabelStyleClass

public java.lang.String getLabelStyleClass()

setLabelStyleClass

public void setLabelStyleClass(java.lang.String styleClass)

getLabel

public java.lang.String getLabel()

Returns:

For internal use only. Application developers should not use this

setLabel

public void setLabel(java.lang.String label)

Specifies the label associated with this TaskbarFormat. Note this text is what gets display in the Legend for the task type this TaskbarFormat is associated with.

Parameters:

label - the label associated with this TaskbarFormat.

getStyleClass

public java.lang.String getStyleClass()

For internal use only. Application developers should not use this

getStartupStyleClass

public java.lang.String getStartupStyleClass()

For internal use only. Application developers should not use this

getLinker

public java.lang.String getLinker()

For internal use only. Application developers should not use this

setLinker

public void setLinker(java.lang.String linker)

For internal use only. Application developers should not use this

getLeftStyleClass

public java.lang.String getLeftStyleClass()

For internal use only. Application developers should not use this

getMiddleStyleClass

public java.lang.String getMiddleStyleClass()

getRightStyleClass

public java.lang.String getRightStyleClass()

For internal use only. Application developers should not use this

getFillColor

public java.lang.String getFillColor()

For internal use only. Application developers should not use this

setFillColor

public void setFillColor(java.lang.String fillColor)

getFillImagePattern

public java.lang.String getFillImagePattern()

For internal use only. Application developers should not use this

getHeight

public int getHeight()

For internal use only. Application developers should not use this

setHeight

public void setHeight(int height)

For internal use only. Application developers should not use this

getLeftImage

public java.lang.String getLeftImage()

For internal use only. Application developers should not use this

getRightImage

public java.lang.String getRightImage()

For internal use only. Application developers should not use this

getBorderColor

public java.lang.String getBorderColor()

For internal use only. Application developers should not use this

setBorderColor

public void setBorderColor(java.lang.String borderColor)

getImage

public java.lang.String getImage()

For internal use only. Application developers should not use this

setLeftShapeOffset

public void setLeftShapeOffset(int offset)

Specify the offset of the left image/style if specified relative to the start of the bar. A positive value means moving the shape to the left while negative value means moving the shape to the right. Default value is zero.

Parameters:

offset -

getLeftShapeOffset

public int getLeftShapeOffset()

Retrieves the offset of the left image/style if specified relative to the start of the bar. A positive value means moving the shape to the left while negative value means moving the shape to the right. Default value is zero.

Returns:

the offset

setRightShapeOffset

public void setRightShapeOffset(int offset)

Specify the offset of the right image/style if specified relative to the end of the bar. A positive value means moving the shape to the right while negative value means moving the shape to the left. Default value is -1.

Parameters:

offset -

getRightShapeOffset

public int getRightShapeOffset()

Retrieves the offset of the right image/style if specified relative to the end of the bar. A positive value means moving the shape to the right while negative value means moving the shape to the left. Default value is -1.

Returns:

the offset

getWidth

public int getWidth()

Gets the width of the resource utilization bar.

For internal use only. Application developers should not use this

isStacked

public boolean isStacked()

Determine whether the task bar is stack on top of the previous one.

Returns:

setStacked

public void setStacked(boolean stacked)

Specifies whether the task bar should be stack on top of the previous one.

Parameters:

stacked -

Skip navigation links