public class WeekRangeSettings extends ViewSettings
WeekRange
view.Modifier and Type | Method and Description |
---|---|
java.lang.Integer |
getDayDistance()
Gets the distance between adjacent days.
|
java.lang.Integer |
getDayNamesHeaderHeight()
Gets the height of the day-names header in the
WeekRange view. |
DayOfWeekFormat |
getDayOfWeekFormat()
Gets the display format of the names of the days of the week.
|
CellSettings |
getDaySettings()
Gets the
CellSettings object used to customize the
visualization of days in a WeekRange view. |
Brush |
getEvenMonthsBrush()
Gets the brush used to paint the background of all even months'
areas in the
WeekRange view. |
java.lang.Boolean |
getGroupWeekends()
Gets a value indicating whether weekend days are grouped
in a single calendar cell.
|
java.lang.String |
getGroupWeekendsTitleSeparator()
Gets the separator string displayed between the weekend
day names when
getGroupWeekends() is enabled. |
java.awt.Color |
getHeaderShadowColor()
Gets the color of the headers' shadows.
|
java.lang.Integer |
getHeaderShadowOffset()
Gets the offset of the shadows from the headers that cast them.
|
ShadowStyle |
getHeaderShadowStyle()
Gets the style of the headers' shadows.
|
java.util.EnumSet<WeekRangeHeaderStyle> |
getHeaderStyle()
Gets the style of the time-period header,
displayed above the day-names header.
|
java.lang.Integer |
getMargin()
Gets the distance between the outermost
border and the rest of the calendar contents.
|
int |
getNumberOfDays()
Gets the total number of days displayed in the
WeekRange view. |
Brush |
getOddMonthsBrush()
Gets the brush used to paint the background
of all odd months' areas in the WeekRange view.
|
java.lang.Integer |
getReferenceHeaderHeight()
Gets the height of the resource header in the
WeekRange view. |
java.lang.Boolean |
getShowDayOfWeek()
Gets a value indicating whether the day names are displayed in
the header area of the
WeekRange view. |
Style |
getStyle()
Gets the appearance style used to paint calendar
elements that don't have a distinct style assigned to them.
|
java.lang.Integer |
getTimePeriodHeaderHeight()
Gets the height of the time-period header in the
WeekRange view. |
java.lang.String |
getTitleFormat()
Gets the format of the calendar's title.
|
java.lang.String |
getTitleSeparator()
Gets the string used as a separator in the calendar's title.
|
WeekRangeViewStyle |
getViewStyle()
Gets the style of the WeekRange view.
|
java.lang.Integer |
getVisibleColumns()
Gets the number of columns visible when
Calendar.getGroupType() is enabled. |
java.lang.Integer |
getVisibleRows()
Gets the number of weeks visible at a time.
|
void |
setDayDistance(java.lang.Integer value)
Sets the distance between adjacent days.
|
void |
setDayNamesHeaderHeight(java.lang.Integer value)
Sets the height of the day-names header in the
WeekRange view. |
void |
setDayOfWeekFormat(DayOfWeekFormat value)
Sets the display format of the names of the days of the week.
|
void |
setEvenMonthsBrush(Brush value)
Sets the brush used to paint the background of all even months'
areas in the
WeekRange view. |
void |
setGroupWeekends(java.lang.Boolean value)
Sets a value indicating whether weekend days are grouped
in a single calendar cell.
|
void |
setGroupWeekendsTitleSeparator(java.lang.String value)
Sets the separator string displayed between the weekend
day names when
getGroupWeekends() is enabled. |
void |
setHeaderShadowColor(java.awt.Color value)
Sets the color of the headers' shadows.
|
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 headers' shadows.
|
void |
setHeaderStyle(java.util.EnumSet<WeekRangeHeaderStyle> value)
Sets the style of the time-period header,
displayed above the day-names header.
|
void |
setMargin(java.lang.Integer value)
Sets the distance between the outermost
border and the rest of the calendar contents.
|
void |
setOddMonthsBrush(Brush value)
Sets the brush used to paint the background
of all odd months' areas in the WeekRange view.
|
void |
setReferenceHeaderHeight(java.lang.Integer value)
Sets the height of the resource header in the
WeekRange view. |
void |
setShowDayOfWeek(java.lang.Boolean value)
Sets a value indicating whether the day names are displayed in
the header area of the
WeekRange view. |
void |
setStyle(Style value)
Sets the appearance style used to paint calendar
elements that don't have a distinct style assigned to them.
|
void |
setTimePeriodHeaderHeight(java.lang.Integer value)
Sets the height of the time-period header in the
WeekRange view. |
void |
setTitleFormat(java.lang.String value)
Sets the format of the calendar's title.
|
void |
setTitleSeparator(java.lang.String value)
Sets the string used as a separator in the calendar's title.
|
void |
setViewStyle(WeekRangeViewStyle value)
Sets the style of the WeekRange view.
|
void |
setVisibleColumns(java.lang.Integer value)
Sets the number of columns visible when
Calendar.getGroupType() is enabled. |
void |
setVisibleRows(java.lang.Integer value)
Sets the number of weeks visible at a time.
|
addChangeListener, removeChangeListener
public CellSettings getDaySettings()
CellSettings
object used to customize the
visualization of days in a WeekRange
view.CellSettings
class.public Style getStyle()
getStyle
in class ViewSettings
Style
class specifying the style
of calendar UI elements. This property cannot be null.public void setStyle(Style value)
setStyle
in class ViewSettings
value
- An instance of the Style
class specifying
the style of calendar UI elements. This property cannot be null.public java.util.EnumSet<WeekRangeHeaderStyle> getHeaderStyle()
WeekRangeHeaderStyle
constants.public void setHeaderStyle(java.util.EnumSet<WeekRangeHeaderStyle> value)
value
- One of the WeekRangeHeaderStyle
constants.
Set to null to use the corresponding value from the current theme.public java.lang.Boolean getShowDayOfWeek()
WeekRange
view.
The day names are obtained from the Calendar.getDateTimeInfo()
object.
public void setShowDayOfWeek(java.lang.Boolean value)
WeekRange
view.
The day names are obtained from the Calendar.getDateTimeInfo()
object.
value
- true to display the day names; otherwise, false.
Set to null to use the corresponding value from the current theme.public Brush getOddMonthsBrush()
Brush
-derived class used to
fill the odd month cells.public void setOddMonthsBrush(Brush value)
value
- An instance of a Brush
-derived class used to
fill the odd month cells. Set to null to use the corresponding
value from the current theme.public Brush getEvenMonthsBrush()
WeekRange
view.Brush
-derived class used to
fill the even month cells.public void setEvenMonthsBrush(Brush value)
WeekRange
view.value
- An instance of a Brush
-derived class used to
fill the even month cells. Set to null to use the corresponding
value from the current theme.public java.lang.Integer getTimePeriodHeaderHeight()
WeekRange
view.
A value of 0 causes the height to be calculated automatically based on the size of the header font.
public void setTimePeriodHeaderHeight(java.lang.Integer value)
WeekRange
view.
A value of 0 causes the height to be calculated automatically based on the size of the header font.
value
- A non-negative integer value specifying the header height in pixels.
Set to null to use the corresponding value from the current theme.public java.lang.Integer getReferenceHeaderHeight()
WeekRange
view.
This header is where the contact, task, location or resource names are displayed,
depending on Calendar.getGroupType()
. A value of 0 causes the height to be
calculated automatically based on the size of the header font.
public void setReferenceHeaderHeight(java.lang.Integer value)
WeekRange
view.
This header is where the contact, task, location or resource names are displayed,
depending on Calendar.getGroupType()
. A value of 0 causes the height to be
calculated automatically based on the size of the header font.
value
- A non-negative integer value specifying the header height.
Set to null to use the corresponding value from the current theme.public java.lang.Integer getDayNamesHeaderHeight()
WeekRange
view.
A value of 0 causes the height to be calculated automatically based on the size of the header font.
public void setDayNamesHeaderHeight(java.lang.Integer value)
WeekRange
view.
A value of 0 causes the height to be calculated automatically based on the size of the header font.
value
- A non-negative integer value specifying the height of the day-names header in pixels.
Set to null to use the corresponding value from the current theme.public int getNumberOfDays()
WeekRange
view.
Use the setDate
and setEndDate
methods
of the Calendar
component to set the time period displayed in the week range view.
public java.lang.Integer getVisibleRows()
Used only when getViewStyle()
is set to WeekRangeViewStyle.WeekPerRow
.
public void setVisibleRows(java.lang.Integer value)
Used only when getViewStyle()
is set to WeekRangeViewStyle.WeekPerRow
.
value
- The allowed values range from 1 to 10.
Set to null to use the corresponding value from the current theme.public java.lang.Boolean getGroupWeekends()
SingleWeek
view.public void setGroupWeekends(java.lang.Boolean value)
SingleWeek
view.value
- true to display weekend days together; otherwise, false.
Set to null to use the corresponding value from the current theme.public WeekRangeViewStyle getViewStyle()
WeekRangeViewStyle
constants.public void setViewStyle(WeekRangeViewStyle value)
value
- One of the WeekRangeViewStyle
constants.
Set to null to use the corresponding value from the current theme.public java.lang.Integer getMargin()
public void setMargin(java.lang.Integer value)
value
- A non-negative integer value specifying the margin size in pixels.
Set to null to use the corresponding value from the current theme.public java.lang.Integer getDayDistance()
public void setDayDistance(java.lang.Integer value)
value
- A non-negative integer value specifying the distance between adjacent day
cells in pixels. Set to null to use the corresponding value from the current theme.public java.lang.String getTitleFormat()
public void setTitleFormat(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.String getTitleSeparator()
public void setTitleSeparator(java.lang.String value)
value
- A string specifying the separator text.
Set to null to use the corresponding value from the current theme.public java.lang.String getGroupWeekendsTitleSeparator()
getGroupWeekends()
is enabled.public void setGroupWeekendsTitleSeparator(java.lang.String value)
getGroupWeekends()
is enabled.value
- A string specifying the separator text.
Set to null to use the corresponding value from the current theme.public DayOfWeekFormat getDayOfWeekFormat()
DayOfWeekFormat
constants.public void setDayOfWeekFormat(DayOfWeekFormat value)
value
- One of the DayOfWeekFormat
constants.
Set to null to use the corresponding value from the current theme.public ShadowStyle getHeaderShadowStyle()
ShadowStyle
enumeration.public void setHeaderShadowStyle(ShadowStyle value)
value
- One of the ShadowStyle
enumeration.
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.Integer getVisibleColumns()
Calendar.getGroupType()
is enabled.
In the week range view schedule data can be displayed in several columns grouped
by contact, location, task or resource, as set in Calendar.getGroupType()
.
This property determines how many parallel columns are visible at a time.
public void setVisibleColumns(java.lang.Integer value)
Calendar.getGroupType()
is enabled.
In the week range view schedule data can be displayed in several columns grouped
by contact, location, task or resource, as set in Calendar.getGroupType()
.
This property determines how many parallel columns are visible at a time.
value
- A positive integer value specifying how many columns are visible simultaneously.
Set to null to use the corresponding value from the current theme.