public final class MonthSettings extends ViewSettings
SingleMonth
and
MonthRange
views.Modifier and Type | Method and Description |
---|---|
MonthCellLayout |
getCellLayout()
Gets the layout of the cells in
SingleMonth
and MonthRange views. |
java.lang.Integer |
getContentsMargin()
Gets the amount of space between the month's day cells and the month's bounding rectangle.
|
DayOfWeekFormat |
getDayOfWeekFormat()
Gets the format of the day names displayed in the week header.
|
CellSettings |
getDaySettings()
Gets the
CellSettings object used to customize the visualization
of days in SingleMonth and
MonthRange views. |
java.lang.Integer |
getDaySpacing()
Gets the amount of space between adjacent days.
|
java.lang.Boolean |
getEnableLanes()
Gets a value indicating whether the view should take into consideration the lanes associated with item.
|
java.lang.Boolean |
getEnableSnapping()
Gets a value indicating whether snapping is enabled.
|
java.lang.Boolean |
getFilterWeekends()
Gets a value indicating whether to hide weekend cells.
|
java.awt.Color |
getHeaderShadowColor()
Gets the color of the header shadows.
|
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<MonthHeaderStyles> |
getHeaderStyle()
Gets the style of the month's header.
|
java.lang.Boolean |
getHideTrailingWeeks()
Gets a value indicating whether to hide trailing weeks,
which do not contain days from the current month.
|
java.lang.Integer |
getLeadingWeekCount()
Gets the number of full weeks to display from the previous month.
|
java.lang.Integer |
getMainHeaderHeight()
Gets the height of the main header in a month view.
|
java.lang.Integer |
getMargin()
Gets the amount of space between the outermost frame of the month and the month's contents.
|
Style |
getPaddingDaysStyle()
Gets the
Style object used to specify appearance
settings for the days from previous and next months, shown
when the getShowPaddingDays() is enabled. |
java.lang.Boolean |
getRotateWeekHeaderTexts()
Gets a value indicating whether the week header texts should be rotated.
|
java.lang.Boolean |
getShowDayOfWeek()
Gets a value indicating whether the day names are displayed in the month's header.
|
java.lang.Boolean |
getShowPaddingDays()
Gets a value indicating whether to display days from the
previous and next months at the beginning and the end of the
current one, in order to fill the whole grid of day cells.
|
java.lang.Boolean |
getShowPaddingItems()
Gets a value indicating whether to show items in padding days.
|
TimeUnit |
getSnapUnit()
Gets the snap unit.
|
Style |
getStyle()
Gets the appearance style used to paint calendar elements
that don't have a distinct style assigned to them.
|
java.lang.Integer |
getSubHeaderHeight()
Gets the height of the secondary header in a SingleMonth view.
|
java.lang.String |
getTitleFormat()
Gets the string used to format the month's title.
|
java.lang.Integer |
getTrailingWeekCount()
Gets the number of full weeks to display from the next month.
|
java.lang.String |
getWeekHeaderFormat()
Gets the format of the text displayed for each week in the week header.
|
MonthWeekHeaderStyle |
getWeekHeaderStyle()
Gets the style of the week numbers header.
|
java.lang.Integer |
getWeekNumbersHeaderWidth()
Gets the width of the header, which displays week numbers.
|
void |
setCellLayout(MonthCellLayout value)
Sets the layout of the cells in
SingleMonth
and MonthRange views. |
void |
setContentsMargin(java.lang.Integer value)
Sets the amount of space between the month's day cells and the month's bounding rectangle.
|
void |
setDayOfWeekFormat(DayOfWeekFormat value)
Sets the format of the day names displayed in the week header.
|
void |
setDaySpacing(java.lang.Integer value)
Sets the amount of space between adjacent days.
|
void |
setEnableLanes(java.lang.Boolean value)
Sets a value indicating whether the view should take into consideration the lanes associated with item.
|
void |
setEnableSnapping(java.lang.Boolean value)
Sets a value indicating whether custom snapping is enabled.
|
void |
setFilterWeekends(java.lang.Boolean value)
Sets a value indicating whether to hide weekend cells.
|
void |
setHeaderShadowColor(java.awt.Color value)
Sets the color of the header 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 shadows cast by headers.
|
void |
setHeaderSpacing(java.lang.Integer value)
Sets the amount of space between headers.
|
void |
setHeaderStyle(java.util.EnumSet<MonthHeaderStyles> value)
Sets the style of the month's header.
|
void |
setHideTrailingWeeks(java.lang.Boolean value)
Sets a value indicating whether to hide trailing weeks,
which do not contain days from the current month.
|
void |
setLeadingWeekCount(java.lang.Integer value)
Sets the number of full weeks to display from the previous month.
|
void |
setMainHeaderHeight(java.lang.Integer value)
Sets the height of the main header in a month view.
|
void |
setMargin(java.lang.Integer value)
Sets the amount of space between the outermost frame of the month and the month's contents.
|
void |
setPaddingDaysStyle(Style value)
Sets the
Style object used to specify appearance
settings for the days from previous and next months, shown
when the getShowPaddingDays() is enabled. |
void |
setRotateWeekHeaderTexts(java.lang.Boolean value)
Sets a value indicating whether the week header texts should be rotated.
|
void |
setShowDayOfWeek(java.lang.Boolean value)
Sets a value indicating whether the day names are displayed in the month's header.
|
void |
setShowPaddingDays(java.lang.Boolean value)
Sets a value indicating whether to display days from the
previous and next months at the beginning and the end of the
current one, in order to fill the whole grid of day cells.
|
void |
setShowPaddingItems(java.lang.Boolean value)
Sets a value indicating whether to show items in padding days.
|
void |
setSnapUnit(TimeUnit value)
Sets the snap unit.
|
void |
setStyle(Style value)
Sets the appearance style used to paint calendar elements
that don't have a distinct style assigned to them.
|
void |
setSubHeaderHeight(java.lang.Integer value)
Sets the height of the secondary header in a SingleMonth view.
|
void |
setTitleFormat(java.lang.String value)
Sets the string used to format the month's title.
|
void |
setTrailingWeekCount(java.lang.Integer value)
Sets the number of full weeks to display from the next month.
|
void |
setWeekHeaderFormat(java.lang.String value)
Sets the format of the text displayed for each week in the week header.
|
void |
setWeekHeaderStyle(MonthWeekHeaderStyle value)
Sets the style of the week numbers header.
|
void |
setWeekNumbersHeaderWidth(java.lang.Integer value)
Sets the width of the header, which displays week numbers.
|
addChangeListener, removeChangeListener
public CellSettings getDaySettings()
CellSettings
object used to customize the visualization
of days in SingleMonth
and
MonthRange
views.CellSettings
class.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 getPaddingDaysStyle()
Style
object used to specify appearance
settings for the days from previous and next months, shown
when the getShowPaddingDays()
is enabled.Style
class. This property cannot be null.public void setPaddingDaysStyle(Style value)
Style
object used to specify appearance
settings for the days from previous and next months, shown
when the getShowPaddingDays()
is enabled.value
- An instance of the Style
class. This property cannot be null.public java.util.EnumSet<MonthHeaderStyles> getHeaderStyle()
MonthHeaderStyles
constants.public void setHeaderStyle(java.util.EnumSet<MonthHeaderStyles> value)
value
- A set of the MonthHeaderStyles
constants.
Set to null to use the corresponding value from the current theme.public java.lang.Boolean getShowDayOfWeek()
The day names are obtained from the DateTimeInfo
object
returned by Calendar.getDateTimeInfo()
.
public void setShowDayOfWeek(java.lang.Boolean value)
The day names are obtained from the DateTimeInfo
object
returned by Calendar.getDateTimeInfo()
.
value
- true to display day names; otherwise, false.
Set to null to use the corresponding value from the current theme.public MonthWeekHeaderStyle getWeekHeaderStyle()
MonthWeekHeaderStyle
constants.public void setWeekHeaderStyle(MonthWeekHeaderStyle value)
value
- One of the MonthWeekHeaderStyle
constants or null.
Set to null to use the corresponding value from the current theme.public java.lang.Boolean getShowPaddingDays()
Padding days are also displayed in the month range view for the first and the last months contained in the view.
public void setShowPaddingDays(java.lang.Boolean value)
Padding days are also displayed in the month range view for the first and the last months contained in the view.
value
- true to display days from the previous and next months
to fill up this month's grid; otherwise, false.
Set to null to use the corresponding value from the current theme.public java.lang.Integer getDaySpacing()
public void setDaySpacing(java.lang.Integer value)
value
- A non-negative integer value specifying how
many pixels to leave between adjacent day cells.
Set to null to use the corresponding value from the current theme.public java.lang.Integer getContentsMargin()
public void setContentsMargin(java.lang.Integer value)
value
- A non-negative integer value specifying how many
pixels to leave between the cells and the month's bounds.
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 margins size in pixels.
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 to
leave between headers. The minimal allowed value is -1.
Set to null to use the corresponding value from the current theme.public java.lang.Integer getMainHeaderHeight()
A value of 0 causes the Calendar
component to automatically
calculate the header size based on the header font size.
public void setMainHeaderHeight(java.lang.Integer value)
A value of 0 causes the Calendar
component to automatically
calculate the header size based on the header font size.
value
- A non-negative integer value specifying the height of the main header in pixels.
Set to null to use the corresponding value from the current theme.public java.lang.Integer getSubHeaderHeight()
A value of 0 causes the Calendar
component to automatically
calculate the header size based on the header font size.
public void setSubHeaderHeight(java.lang.Integer value)
A value of 0 causes the Calendar
component to automatically
calculate the header size based on the header font size.
value
- A non-negative integer value specifying the height of the header in pixels.
Set to null to use the corresponding value from the current theme.public java.lang.Integer getWeekNumbersHeaderWidth()
A value of 0 causes the Calendar
component to automatically
calculate the header size based on the header font size.
public void setWeekNumbersHeaderWidth(java.lang.Integer value)
A value of 0 causes the Calendar
component to automatically
calculate the header size based on the header font size.
value
- A non-negative integer value specifying the header width 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 DayOfWeekFormat getDayOfWeekFormat()
DayOfWeekFormat
constants.public void setDayOfWeekFormat(DayOfWeekFormat value)
value
- One of the DayOfWeekFormat
constants or null.
Set to null to use the corresponding value from the current theme.public java.lang.String getWeekHeaderFormat()
public void setWeekHeaderFormat(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.Boolean getRotateWeekHeaderTexts()
public void setRotateWeekHeaderTexts(java.lang.Boolean value)
value
- true to rotate the texts in the week header; otherwise, false.
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 or null.
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 how many pixels there are between
headers and their shadows. The allowed values range from 1 to 5.
Set to null to use the corresponding value from the current theme.public java.lang.Integer getLeadingWeekCount()
public void setLeadingWeekCount(java.lang.Integer value)
value
- A non-negative integer value specifying the number of
weeks to display before the first week of the selected month.
Set to null to use the corresponding value from the current theme.public java.lang.Integer getTrailingWeekCount()
public void setTrailingWeekCount(java.lang.Integer value)
value
- A non-negative integer value specifying the number of
weeks to display after the selected month.
Set to null to use the corresponding value from the current theme.public MonthCellLayout getCellLayout()
SingleMonth
and MonthRange
views.MonthCellLayout
constants.public void setCellLayout(MonthCellLayout value)
SingleMonth
and MonthRange
views.value
- One of the MonthCellLayout
constants or null.
Set to null to use the corresponding value from the current theme.public java.lang.Boolean getHideTrailingWeeks()
Boolean
value.public void setHideTrailingWeeks(java.lang.Boolean value)
value
- A Boolean
value.
Set to null to use the corresponding value from the current theme.public java.lang.Boolean getShowPaddingItems()
public void setShowPaddingItems(java.lang.Boolean value)
value
- true to display items from the previous and
next months in the padding days; otherwise, false.
Set to null to use the corresponding value from the current theme.public java.lang.Boolean getFilterWeekends()
This property is ignored if getCellLayout()
is MonthCellLayout.Linear
.
Boolean
value.public void setFilterWeekends(java.lang.Boolean value)
This property is ignored if getCellLayout()
is MonthCellLayout.Linear
.
value
- A Boolean
value.
Set to null to use the corresponding value from the current theme.public TimeUnit getSnapUnit()
Use this property in a conjunction with setEnableSnapping(java.lang.Boolean)
to specify
the precision with which users can move and resize items interactively.
If setEnableSnapping(java.lang.Boolean)
is set to false the value of this property
is ignored and items snap to cell borders.
TimeUnit
constants.public void setSnapUnit(TimeUnit value)
Use this property in a conjunction with setEnableSnapping(java.lang.Boolean)
to specify
the precision with which users can move and resize items interactively.
If setEnableSnapping(java.lang.Boolean)
is set to false the value of this property
is ignored and items snap to cell borders.
value
- One of the TimeUnit
constants. Set to null
to use the corresponding value from the current theme.public java.lang.Boolean getEnableSnapping()
When this property is enabled, the users will move and resize items with
the precision specified by getSnapUnit()
instead of the precision
of the view's resolution. When this property is disabled, the items will
snap automatically to the border of their containing cells.
Boolean
value.public void setEnableSnapping(java.lang.Boolean value)
When this property is enabled, the users will move and resize items with
the precision specified by getSnapUnit()
instead of the precision
of the view's resolution. When this property is disabled, the items will
snap automatically to the border of their containing cells.
value
- A Boolean
value. Set to null to use the corresponding
value from the current theme.public java.lang.Boolean getEnableLanes()
Boolean
value.public void setEnableLanes(java.lang.Boolean value)
value
- A Boolean
value. Set to null to use the corresponding
value from the current theme.