public final class TimelineSettings
extends java.lang.Object
Resource
view.Modifier and Type | Method and Description |
---|---|
java.lang.Boolean |
getExtendedCurrentTimeMarker()
Gets whether current-time marker spans the full extent of resource view.
|
java.lang.String |
getFormat()
Gets the format of the displayed dates in the timeline.
|
java.awt.Color |
getNowColor()
Gets the color used to mark the current time in the timeline.
|
java.awt.Color |
getNowFillColor()
Gets the fill color used to mark the current time in the timeline.
|
java.lang.Boolean |
getShowCurrentTime()
Gets a value indicating whether to indicate the current time in the timeline.
|
java.lang.Boolean |
getShowTicks()
Gets a value indicating whether the timeline displays tick lines.
|
java.lang.Integer |
getSize()
Gets the size of the timeline.
|
java.lang.Integer |
getSpanCellCount()
Gets a value indicating the number of cells to span when
SpanTexts is enabled. |
java.lang.Boolean |
getSpanTexts()
Gets a value indicating whether some cell texts will span more than one cell when
the space in their corresponding cells is insufficient due to scaling the view.
|
Style |
getStyle()
Gets the style of the timeline.
|
java.lang.Integer |
getTickSize()
Gets the size of the ticks displayed in the timeline.
|
TimeUnit |
getUnit()
Gets the time unit of the timeline.
|
java.lang.Integer |
getUnitCount()
Gets the number of units between adjacent ticks in the timeline.
|
boolean |
isSettingsChanged()
Gets a value indicating whether unit, format or unitcount has changed;
|
void |
setExtendedCurrentTimeMarker(java.lang.Boolean value)
Sets whether current-time marker spans the full extent of resource view.
|
void |
setFormat(java.lang.String value)
Sets the format of the displayed dates in the timeline.
|
void |
setNowColor(java.awt.Color value)
Sets the color used to mark the current time in the timeline.
|
void |
setNowFillColor(java.awt.Color value)
Sets the fill color used to mark the current time in the timeline.
|
void |
setShowCurrentTime(java.lang.Boolean value)
Sets a value indicating whether to indicate the current time in the timeline.
|
void |
setShowTicks(java.lang.Boolean value)
Sets a value indicating whether the timeline displays tick lines.
|
void |
setSize(java.lang.Integer value)
Sets the size of the timeline.
|
void |
setSpanCellCount(java.lang.Integer value)
Sets a value indicating the number of cells to span when
SpanTexts is enabled. |
void |
setSpanTexts(java.lang.Boolean value)
Sets a value indicating whether some cell texts will span more than one cell when
the space in their corresponding cells is insufficient due to scaling the view.
|
void |
setStyle(Style value)
Sets the style of the timeline.
|
void |
setTickSize(java.lang.Integer value)
Sets the size of the ticks displayed in the timeline.
|
void |
setUnit(TimeUnit value)
Sets the time unit of the timeline.
|
void |
setUnitCount(java.lang.Integer value)
Sets the number of units between adjacent ticks in the timeline.
|
public Style getStyle()
Style
object specifying the style of the timeline.
This property cannot be null.public void setStyle(Style value)
value
- A Style
object specifying the style of the timeline.
This property cannot be null.public TimeUnit getUnit()
TimeUnit
constants.public void setUnit(TimeUnit value)
value
- One of the TimeUnit
constants.
Set to null to use the corresponding value from the current theme.public java.lang.Integer getUnitCount()
public void setUnitCount(java.lang.Integer value)
value
- A non-negative integer value.
Set to null to use the corresponding value from the current theme.public java.lang.String getFormat()
public void setFormat(java.lang.String value)
value
- A string specifying the display format.
Set to null to use the corresponding value from the current theme.public java.lang.Integer getSize()
A value of 0 causes the size to be calculated automatically based on the size of the header font.
public void setSize(java.lang.Integer value)
A value of 0 causes the size to be calculated automatically based on the size of the header font.
value
- A non-negative integer value.
Set to null to use the corresponding value from the current theme.public java.lang.Boolean getShowTicks()
Boolean
value.public void setShowTicks(java.lang.Boolean value)
value
- A Boolean
value.
Set to null to use the corresponding value from the current theme.public java.lang.Integer getTickSize()
public void setTickSize(java.lang.Integer value)
value
- A non-negative integer value.
Set to null to use the corresponding value from the current theme.public java.lang.Boolean getSpanTexts()
The number of spanned cells is specified by the SpanCellCount
property. If the value of this property is 0, then the number of cells is automatically
calculated based on the current scale factor, which is specified by the
TimelineScale
property.
Boolean
value.public void setSpanTexts(java.lang.Boolean value)
The number of spanned cells is specified by the SpanCellCount
property. If the value of this property is 0, then the number of cells is automatically
calculated based on the current scale factor, which is specified by the
TimelineScale
property.
value
- A Boolean
value.
Set to null to use the corresponding value from the current theme.public java.lang.Integer getSpanCellCount()
SpanTexts
is enabled.
If this value is 0, it is automatically calculated based on the current
scale factor, which is specified by TimelineScale
.
public void setSpanCellCount(java.lang.Integer value)
SpanTexts
is enabled.
If this value is 0, it is automatically calculated based on the current
scale factor, which is specified by TimelineScale
.
value
- A non-negative integer value specifying the number of cells to span.
Set to null to use the corresponding value from the current theme.public java.lang.Boolean getShowCurrentTime()
public void setShowCurrentTime(java.lang.Boolean value)
value
- true to indicate the current time; otherwise, false.
Set to null to use the corresponding value from the current theme.public java.lang.Boolean getExtendedCurrentTimeMarker()
public void setExtendedCurrentTimeMarker(java.lang.Boolean value)
value
- true to span full extent, or false to span only header area.public java.awt.Color getNowColor()
public void setNowColor(java.awt.Color value)
value
- A Color object specifying the color used to indicate the current time.
Set to null to use the corresponding value from the current theme.public java.awt.Color getNowFillColor()
public void setNowFillColor(java.awt.Color value)
value
- A Color object specifying the color used to indicate the current time.
Set to null to use the corresponding value from the current theme.public boolean isSettingsChanged()