public class ResourceViewSettings extends ViewSettings
Resource
view.Modifier and Type | Method and Description |
---|---|
java.lang.Boolean |
getAllowReorderResources()
Gets a value indicating whether users are allowed to reorder resource rows via drag and drop.
|
java.lang.Boolean |
getAllowResizeRowHeaders()
Gets a value indicating whether the users can resize the row
headers when
GroupRowHeader is enabled. |
TimelineSettings |
getBottomTimelineSettings()
Gets the settings for the bottom timeline.
|
float |
getCellOffset()
Gets the time offset of the first cell from the origin of the resource view.
|
java.lang.Boolean |
getEnableCollisions()
Gets a value indicating whether the item collision processing is enabled.
|
java.lang.Boolean |
getEnableRowTitleFormat()
Gets a value indicating whether the
RowTitleFormat
property will be taken into consideration. |
java.lang.Boolean |
getExpandableRows()
Gets a value indicating whether the rows in the resource view can be expanded/collapsed.
|
ItemAction |
getExpandActiveItemOn()
Gets whether the active item should ignore collisions.
|
LineStyle |
getGridStyle()
Gets the style of the grid lines.
|
java.lang.Boolean |
getGroupRowHeader()
Gets a value indicating whether the rows display the header as a group header.
|
java.awt.Color |
getHeaderShadowColor()
Gets the color of the shadow cast by headers.
|
java.lang.Integer |
getHeaderShadowOffset()
Gets the offset of the shadows from the headers that cast them.
|
ShadowStyle |
getHeaderShadowStyle()
Gets the style of the shadows cast by headers.
|
java.lang.Integer |
getHeaderSpacing()
Gets the amount of space between headers.
|
java.util.EnumSet<DayOfWeek> |
getHiddenDays()
Gets the days of the week that should not be displayed in a resource view.
|
LineStyle |
getInnerGridStyle()
Gets the style of the internal grid lines.
|
java.lang.Integer |
getLaneSize()
Gets the size of a single lane.
|
TimelineSettings |
getMiddleTimelineSettings()
Gets the settings for the middle timeline.
|
java.lang.Integer |
getMinItemSize()
Gets the smallest size allowed for resource items.
|
java.lang.Integer |
getMinResourceLength()
Gets the minimum length for resources when
ResourceLengthMethod
is set to MinimumFixed . |
java.lang.Integer |
getMinRowSize()
Gets the smallest size allowed for resource rows.
|
java.awt.Color |
getReorderIndicatorColor()
Gets the color of reorder indicator line.
|
java.lang.Integer |
getReorderIndicatorWidth()
Gets the width of reorder indicator line.
|
ResourceLengthMethod |
getResourceLengthMethod()
Gets the method used to calculate the length of the resources.
|
ResourceResizeMethod |
getResourceResizeMethod()
Gets the method to be used when resizing resources in the view.
|
java.lang.Integer |
getRowHeaderSize()
Gets the size of the row header.
|
java.lang.String |
getRowTitleFormat()
Gets the string used to format and display resource titles in row headers.
|
Duration |
getScrollStep()
Gets the time modification interval when the user scrolls the view.
|
java.lang.Boolean |
getShowPaddingDates()
Gets a value indicating whether to display padding dates.
|
java.lang.Boolean |
getShowResourceDuration()
Gets a value indicating whether to display the duration of individual resources.
|
java.lang.Boolean |
getShowSubTicks()
Gets a value indicating whether the view displays sub ticks in the bottom timeline.
|
TimeUnit |
getSnapUnit()
Gets the snap unit.
|
java.lang.Integer |
getSnapUnitCount()
Gets the snap unit count.
|
Style |
getStyle()
Gets the appearance style used to paint calendar
elements that don't have a distinct style assigned to them.
|
java.lang.Integer |
getSubTickSize()
Gets the size of the sub ticks displayed in the bottom timeline.
|
java.lang.Integer |
getTimelines()
Gets the number of timelines displayed in the view.
|
java.lang.Integer |
getTimelineScale()
Gets the scale factor of the timeline.
|
TimelineSettings |
getTopTimelineSettings()
Gets the settings for the top timeline.
|
ResourceViewStyle |
getViewStyle()
Gets the style of the view.
|
Duration |
getVisibleEndTime()
Gets the last visible time of displayed days.
|
java.lang.Integer |
getVisibleRows()
Gets the number of rows visible in the view.
|
Duration |
getVisibleStartTime()
Gets the first visible time of displayed days.
|
Style |
getWeekendStyle()
Gets the style of the weekend cells.
|
void |
setAllowReorderResources(java.lang.Boolean value)
Sets a value indicating whether users are allowed to reorder resource rows via drag and drop.
|
void |
setAllowResizeRowHeaders(java.lang.Boolean value)
Sets a value indicating whether the users can resize the row
headers when
GroupRowHeader is enabled. |
void |
setCellOffset(float value)
Sets the time offset of the first cell from the origin of the resource view.
|
void |
setEnableCollisions(java.lang.Boolean value)
Gets a value indicating whether the item collision processing is enabled.
|
void |
setEnableRowTitleFormat(java.lang.Boolean value)
Sets a value indicating whether the
RowTitleFormat
property will be taken into consideration. |
void |
setExpandableRows(java.lang.Boolean value)
Sets a value indicating whether the rows in the resource view can be expanded/collapsed.
|
void |
setExpandActiveItemOn(ItemAction value)
Sets whether the active item should ignore collisions.
|
void |
setGridStyle(LineStyle value)
Sets the style of the grid lines.
|
void |
setGroupRowHeader(java.lang.Boolean value)
Sets a value indicating whether the rows display the header as a group header.
|
void |
setHeaderShadowColor(java.awt.Color value)
Sets the color of the shadow cast by headers.
|
void |
setHeaderShadowOffset(java.lang.Integer value)
Sets the offset of the shadows from the headers that cast them.
|
void |
setHeaderShadowStyle(ShadowStyle value)
Sets the style of the shadows cast by headers.
|
void |
setHeaderSpacing(java.lang.Integer value)
Sets the amount of space between headers.
|
void |
setHiddenDays(java.util.EnumSet<DayOfWeek> value)
Sets the days of the week that should not be displayed in a resource view.
|
void |
setInnerGridStyle(LineStyle value)
Sets the style of the internal grid lines.
|
void |
setLaneSize(java.lang.Integer value)
Sets the size of a single lane.
|
void |
setMinItemSize(java.lang.Integer value)
Sets the smallest size allowed for resource items.
|
void |
setMinResourceLength(java.lang.Integer value)
Sets the minimum length for resources when
ResourceLengthMethod
is set to MinimumFixed . |
void |
setMinRowSize(java.lang.Integer value)
Sets the smallest size allowed for resource rows.
|
void |
setReorderIndicatorColor(java.awt.Color value)
Sets the color of reorder indicator line.
|
void |
setReorderIndicatorWidth(java.lang.Integer value)
Sets the width of reorder indicator line.
|
void |
setResourceLengthMethod(ResourceLengthMethod value)
Sets the method used to calculate the length of the resources.
|
void |
setResourceResizeMethod(ResourceResizeMethod value)
Sets the method to be used when resizing resources in the view.
|
void |
setRowHeaderSize(java.lang.Integer value)
Sets the size of the row header.
|
void |
setRowTitleFormat(java.lang.String value)
Sets the string used to format and display resource titles in row headers.
|
void |
setScrollStep(Duration value)
Sets the time modification interval when the user scrolls the view.
|
void |
setShowPaddingDates(java.lang.Boolean value)
Sets a value indicating whether to display padding dates.
|
void |
setShowResourceDuration(java.lang.Boolean value)
Sets a value indicating whether to display the duration of individual resources.
|
void |
setShowSubTicks(java.lang.Boolean value)
Sets a value indicating whether the view displays sub ticks in the bottom timeline.
|
void |
setSnapUnit(TimeUnit value)
Sets the snap unit.
|
void |
setSnapUnitCount(java.lang.Integer value)
Sets the snap unit count.
|
void |
setStyle(Style value)
Sets the appearance style used to paint calendar
elements that don't have a distinct style assigned to them.
|
void |
setSubTickSize(java.lang.Integer value)
Sets the size of the sub ticks displayed in the bottom timeline.
|
void |
setTimelines(java.lang.Integer value)
Sets the number of timelines displayed in the view.
|
void |
setTimelineScale(java.lang.Integer value)
Sets the scale factor of the timeline.
|
void |
setViewStyle(ResourceViewStyle value)
Sets the style of the view.
|
void |
setVisibleEndTime(Duration value)
Sets the last visible time of displayed days.
|
void |
setVisibleRows(java.lang.Integer value)
Sets the number of rows visible in the view.
|
void |
setVisibleStartTime(Duration value)
Sets the first visible time of displayed days.
|
void |
setWeekendStyle(Style value)
Sets the style of the weekend cells.
|
addChangeListener, removeChangeListener
public Style getStyle()
getStyle
in class ViewSettings
Style
object specifying the style of calendar UI elements.
This property cannot be null.public void setStyle(Style value)
setStyle
in class ViewSettings
value
- A Style
object specifying the style of calendar UI elements.
This property cannot be null.public Style getWeekendStyle()
Style
object specifying the appearance of weekend cells.
This property cannot be null.public void setWeekendStyle(Style value)
value
- A Style
object specifying the appearance of weekend cells.
This property cannot be null.public ResourceViewStyle getViewStyle()
ResourceViewStyle
constants.public void setViewStyle(ResourceViewStyle value)
value
- One of the ResourceViewStyle
constants.
Set to null to use the corresponding value from the current theme.public java.lang.Integer getTimelines()
public void setTimelines(java.lang.Integer value)
value
- An integer value specifying the number of timelines visible in the view.
The allowed values range from 1 to 3.
Set to null to use the corresponding value from the current theme.public java.lang.Integer getTimelineScale()
Usually the size of the cells in the CalendarView.ResourceView
is calculated to be
large enough so that the texts in the timeline can fit without clipping. By using values other
than 100 for this property, you can scale up or down the precalculated size of the cells.
public void setTimelineScale(java.lang.Integer value)
Usually the size of the cells in the CalendarView.ResourceView
is calculated to be
large enough so that the texts in the timeline can fit without clipping. By using values other
than 100 for this property, you can scale up or down the precalculated size of the cells.
value
- An integer value specifying the scale of the timeline expressed in percents.
The allowed values range from 10 to 1000.
Set to null to use the corresponding value from the current theme.public TimelineSettings getBottomTimelineSettings()
TimelineSettings
class
that defines the preferences for the bottom timeline.public TimelineSettings getMiddleTimelineSettings()
TimelineSettings
class
that defines the preferences for the bottom timeline.public TimelineSettings getTopTimelineSettings()
TimelineSettings
class
that defines the preferences for the bottom timeline.public Duration getScrollStep()
Duration
object that defines the scroll interval.
The minimal allowed value is 1 second.public void setScrollStep(Duration value)
value
- A Duration
object that defines the scroll interval.
The minimal allowed value is 1 second.
Set to null to use the corresponding value from the current theme.public java.lang.Integer getHeaderSpacing()
public void setHeaderSpacing(java.lang.Integer value)
value
- An integer value specifying how many pixels there are
between adjacent headers. The minimal allowed value is -1.
Set to null to use the corresponding value from the current theme.public java.lang.Integer getLaneSize()
This property is only used when ViewStyle
is set to ResourceViewStyle.Lanes
.
public void setLaneSize(java.lang.Integer value)
This property is only used when ViewStyle
is set to ResourceViewStyle.Lanes
.
value
- An integer value specifying the size in pixels
of a resource lane. The minimal allowed value is 10.
Set to null to use the corresponding value from the current theme.public java.lang.Boolean getGroupRowHeader()
This property is only used if ViewStyle
is set to ResourceViewStyle.Lanes
.
Boolean
value. true to activate this feature or false to turn it off.public void setGroupRowHeader(java.lang.Boolean value)
This property is only used if ViewStyle
is set to ResourceViewStyle.Lanes
.
value
- A Boolean
value. true to activate this feature or false to turn it off.
Set to null to use the corresponding value from the current theme.public java.lang.Integer getRowHeaderSize()
The size of a header is used only when GroupRowHeader
is enabled. Otherwise, the size of the header equals LaneSize
.
public void setRowHeaderSize(java.lang.Integer value)
The size of a header is used only when GroupRowHeader
is enabled. Otherwise, the size of the header equals LaneSize
.
value
- An integer value specifying the size in pixels of the row headers.
Set to null to use the corresponding value from the current theme.public java.lang.Boolean getExpandableRows()
This property is only used if ViewStyle
is set to ResourceViewStyle.Lanes
.
Boolean
value.public void setExpandableRows(java.lang.Boolean value)
This property is only used if ViewStyle
is set to ResourceViewStyle.Lanes
.
value
- A Boolean
value.
Set to null to use the corresponding value from the current theme.public ItemAction getExpandActiveItemOn()
ItemAction
constants.public void setExpandActiveItemOn(ItemAction value)
value
- One of the ItemAction
constants.
Set to null to use the corresponding value from the current theme.public LineStyle getGridStyle()
LineStyle
constants.public void setGridStyle(LineStyle value)
value
- One of the LineStyle
constants.
Set to null to use the corresponding value from the current theme.public LineStyle getInnerGridStyle()
LineStyle
constants.public void setInnerGridStyle(LineStyle value)
value
- One of the LineStyle
constants.
Set to null to use the corresponding value from the current theme.public ResourceLengthMethod getResourceLengthMethod()
ResourceLengthMethod
constants.public void setResourceLengthMethod(ResourceLengthMethod value)
value
- One of the ResourceLengthMethod
constants.
Set to null to use the corresponding value from the current theme.public java.lang.Integer getMinResourceLength()
ResourceLengthMethod
is set to MinimumFixed
.public void setMinResourceLength(java.lang.Integer value)
ResourceLengthMethod
is set to MinimumFixed
.value
- An integer value, specifying the minimal resource length in pixels.
The minimal allowed value is 5.
Set to null to use the corresponding value from the current theme.public java.lang.Integer getVisibleRows()
This property is only used when ViewStyle
is set to General
.
public void setVisibleRows(java.lang.Integer value)
This property is only used when ViewStyle
is set to General
.
value
- An integer value specifying the number of rows visible at a time.
The minimal allowed value is 1.
Set to null to use the corresponding value from the current theme.public java.lang.Integer getMinRowSize()
This property is only used when ViewStyle
is set to General
.
public void setMinRowSize(java.lang.Integer value)
This property is only used when ViewStyle
is set to General
.
value
- An integer value, specifying the minimal row size in pixels.
The minimal allowed value is 10.
Set to null to use the corresponding value from the current theme.public java.lang.Integer getMinItemSize()
If there is not enough space in a row to display all related items, the items that do not
fit remain invisible. This property is only used when ViewStyle
is set to General
.
public void setMinItemSize(java.lang.Integer value)
If there is not enough space in a row to display all related items, the items that do not
fit remain invisible. This property is only used when ViewStyle
is set to General
.
value
- An integer value, specifying the minimal item size in pixels.
The minimal allowed value is 5.
Set to null to use the corresponding value from the current theme.public TimeUnit getSnapUnit()
Specifies the time unit of the nearest value to align to when an item is being
modified interactively. For example specifying Day
causes
the manipulated item to always be aligned to the nearest day. To practically
disable snapping, specify Second
for this property.
TimeUnit
constants.public void setSnapUnit(TimeUnit value)
Specifies the time unit of the nearest value to align to when an item is being
modified interactively. For example specifying Day
causes
the manipulated item to always be aligned to the nearest day. To practically
disable snapping, specify Second
for this property.
value
- One of the TimeUnit
constants.
Set to null to use the corresponding value from the current theme.public java.lang.Integer getSnapUnitCount()
When getSnapUnitCount()
is 1 the snapping is absolute. When getSnapUnitCount()
is greater than 1, then the snapping is relative to the element being dragged. For example,
if the item is moved or its start is being resized, the snapping is relative to the item's
start. If the item's end is being resized, the snapping is relative to the item's end.
For example, if the item starts at 02/16, the unit count is 3 and the unit is
Day
, an attempt to resize the item's start on the left would cause
snapping at 02/13 (which is the item's start time minus 3 days).
public void setSnapUnitCount(java.lang.Integer value)
When getSnapUnitCount()
is 1 the snapping is absolute. When getSnapUnitCount()
is greater than 1, then the snapping is relative to the element being dragged. For example,
if the item is moved or its start is being resized, the snapping is relative to the item's
start. If the item's end is being resized, the snapping is relative to the item's end.
For example, if the item starts at 02/16, the unit count is 3 and the unit is
Day
, an attempt to resize the item's start on the left would cause
snapping at 02/13 (which is the item's start time minus 3 days).
value
- A positive integer value specifying the number
of units from the associated SnapUnit to snap to.
Set to null to use the corresponding value from the current theme.public java.lang.Boolean getShowSubTicks()
Boolean
value.public void setShowSubTicks(java.lang.Boolean value)
value
- A Boolean
value.
Set to null to use the corresponding value from the current theme.public java.lang.Integer getSubTickSize()
public void setSubTickSize(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 getShowResourceDuration()
Boolean
value.public void setShowResourceDuration(java.lang.Boolean value)
value
- A Boolean
value.
Set to null to use the corresponding value from the current theme.public ResourceResizeMethod getResourceResizeMethod()
ResourceResizeMethod
constants.public void setResourceResizeMethod(ResourceResizeMethod value)
value
- One of the ResourceResizeMethod
constants.
Set to null to use the corresponding value from the current theme.public ShadowStyle getHeaderShadowStyle()
ShadowStyle
constants.public void setHeaderShadowStyle(ShadowStyle value)
value
- One of the ShadowStyle
constants.
Set to null to use the corresponding value from the current theme.public java.awt.Color getHeaderShadowColor()
public void setHeaderShadowColor(java.awt.Color value)
value
- A Color object specifying the color of headers' shadows.
Set to null to use the corresponding value from the current theme.public java.lang.Integer getHeaderShadowOffset()
public void setHeaderShadowOffset(java.lang.Integer value)
value
- An integer value specifying with how many pixels to offset a
header's shadow from the header. The allowed values range from 1 to 5.
Set to null to use the corresponding value from the current theme.public java.lang.Boolean getShowPaddingDates()
It is sometimes possible that the control draws dates outside of the range specified by
the Date
and EndDate
properties.
This usually happens when the viewport is larger than the entire time range. Set this
property to false if you don't want the control to draw external dates.
Boolean
value.public void setShowPaddingDates(java.lang.Boolean value)
It is sometimes possible that the control draws dates outside of the range specified by
the Date
and EndDate
properties.
This usually happens when the viewport is larger than the entire time range. Set this
property to false if you don't want the control to draw external dates.
value
- A Boolean
value.
Set to null to use the corresponding value from the current theme.public java.util.EnumSet<DayOfWeek> getHiddenDays()
This property determines which days should be filtered (that is, not displayed)
in a resource view. This setting only works if the Unit
of the bottom timeline is set to Day
or Hour
.
DayOfWeek
constants indicating
the visible days in a ResourceView
.public void setHiddenDays(java.util.EnumSet<DayOfWeek> value)
This property determines which days should be filtered (that is, not displayed)
in a resource view. This setting only works if the Unit
of the bottom timeline is set to Day
or Hour
.
value
- One or more of the DayOfWeek
constants indicating
the visible days in a ResourceView
.public Duration getVisibleStartTime()
This property along with the VisibleEndTime
property
determine the range of hours displayed in a resource view for each day. The rest
of the day is filtered (that is, the hours outside this range are not displayed).
Despite being a Duration
, only the Hour
component
is taken into consideration when filtering. Furthermore, this setting only works
if the Unit
property of the bottom timeline is
set to Hour
and the UnitCount
is set
to 1 or if the Unit
is set to Minute
.
Duration
value indicating the first visible
hour of the day in a ResourceView
.public void setVisibleStartTime(Duration value)
This property along with the VisibleEndTime
property
determine the range of hours displayed in a resource view for each day. The rest
of the day is filtered (that is, the hours outside this range are not displayed).
Despite being a Duration
, only the Hour
component
is taken into consideration when filtering. Furthermore, this setting only works
if the Unit
property of the bottom timeline is
set to Hour
and the UnitCount
is set
to 1 or if the Unit
is set to Minute
.
value
- A Duration
value indicating the first visible
hour of the day in a ResourceView
.public Duration getVisibleEndTime()
This property along with the VisibleEndTime
property
determine the range of hours displayed in a resource view for each day. The rest
of the day is filtered (that is, the hours outside this range are not displayed).
Despite being a Duration
, only the Hour
component
is taken into consideration when filtering. Furthermore, this setting only works
if the Unit
property of the bottom timeline is
set to Hour
and the UnitCount
is set
to 1 or if the Unit
is set to Minute
.
Duration
value indicating the last visible
hour of the day in a ResourceView
.public void setVisibleEndTime(Duration value)
This property along with the VisibleEndTime
property
determine the range of hours displayed in a resource view for each day. The rest
of the day is filtered (that is, the hours outside this range are not displayed).
Despite being a Duration
, only the Hour
component
is taken into consideration when filtering. Furthermore, this setting only works
if the Unit
property of the bottom timeline is
set to Hour
and the UnitCount
is set
to 1 or if the Unit
is set to Minute
.
value
- A Duration
value indicating the last visible
hour of the day in a ResourceView
.public float getCellOffset()
Unit
property of the
BottomTimelineSettings
.public void setCellOffset(float value)
value
- A floating point value, specifying the offset in the units set
in the Unit
property of the
BottomTimelineSettings
.public java.lang.Boolean getEnableRowTitleFormat()
RowTitleFormat
property will be taken into consideration.
If this property is disabled the title of each row is determined by to the type
of resources the view is currently grouped by. If the view is grouped by contacts,
the title displays the FirstName
,
MiddleName
and LastName
of the contact according to the pattern specified by Calendar.getContactNameFormat()
.
If the view is grouped by locations or resources, the title displays the
Name
of the resource. If the view is grouped by
tasks, the title displays the Subject
of the task.
Boolean
value.public void setEnableRowTitleFormat(java.lang.Boolean value)
RowTitleFormat
property will be taken into consideration.
If this property is disabled the title of each row is determined by to the type
of resources the view is currently grouped by. If the view is grouped by contacts,
the title displays the FirstName
,
MiddleName
and LastName
of the contact according to the pattern specified by Calendar.getContactNameFormat()
.
If the view is grouped by locations or resources, the title displays the
Name
of the resource. If the view is grouped by
tasks, the title displays the Subject
of the task.
value
- A Boolean
value.
Set to null to use the corresponding value from the current theme.public java.lang.Boolean getAllowResizeRowHeaders()
GroupRowHeader
is enabled.Boolean
value.public void setAllowResizeRowHeaders(java.lang.Boolean value)
GroupRowHeader
is enabled.value
- A Boolean
value.
Set to null to use the corresponding value from the current theme.public java.lang.Boolean getEnableCollisions()
Turn this flag off if you don't need collision detection to improve performance.
Boolean
value.public void setEnableCollisions(java.lang.Boolean value)
Turn this flag off if you don't need collision detection to improve performance.
value
- A Boolean
value.public java.lang.String getRowTitleFormat()
The getRowTitleFormat()
represents raw text containing property
references enclosed in curly brackets. The following is an example of
a formatting string containing a single reference to a property called Name:
This is {Name}.
The value of the referenced property is obtained from the resource object associated with the row whose title is being formatted with this string.
public void setRowTitleFormat(java.lang.String value)
The getRowTitleFormat()
represents raw text containing property
references enclosed in curly brackets. The following is an example of
a formatting string containing a single reference to a property called Name:
This is {Name}.
The value of the referenced property is obtained from the resource object associated with the row whose title is being formatted with this string.
value
- A string specifying the display format.
Set to null to use the corresponding value from the current theme.public java.lang.Boolean getAllowReorderResources()
Boolean
value.public void setAllowReorderResources(java.lang.Boolean value)
value
- A Boolean
value.
Set to null to use the corresponding value from the current theme.public java.awt.Color getReorderIndicatorColor()
public void setReorderIndicatorColor(java.awt.Color value)
value
- A Color object specifying the color of reorder indicator.public java.lang.Integer getReorderIndicatorWidth()
public void setReorderIndicatorWidth(java.lang.Integer value)
value
- An Integer object specifying the width of reorder indicator.