public final class MonthRangeSettings extends ViewSettings
Modifier and Type | Method and Description |
---|---|
java.lang.Integer |
getContentsMargin()
Gets the amount of space between the contents border
and the actual contents of the view.
|
java.lang.Integer |
getHeaderHeight()
Gets the height of the header in a
MonthRange view. |
java.awt.Color |
getHeaderShadowColor()
Gets the color of the shadows 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 the headers.
|
java.util.EnumSet<MonthRangeHeaderStyles> |
getHeaderStyle()
Gets the style of the
MonthRange view header. |
java.lang.Integer |
getMargin()
Gets the amount of space between the outermost border
of the view and its contents.
|
java.lang.Integer |
getMonthSpacing()
Gets the amount of space between adjacent months.
|
java.lang.Integer |
getMonthsPerRow()
Gets the number of months to be displayed in a row.
|
java.lang.Integer |
getNumberOfMonths()
Gets the number of months to display in the
MonthRange view. |
java.lang.Integer |
getScrollInterval()
Gets the number of months to scroll the view back
or forth in time when a scroll button is pressed.
|
Style |
getStyle()
Gets the appearance style used to paint calendar
elements that don't have a distinct style assigned to them.
|
java.lang.String |
getTitleFormat()
Gets the string used to format the month titles.
|
java.lang.String |
getTitleSeparator()
Gets the string used as a title separator in a
MonthRange view that displays
more than 1 month at a time. |
java.lang.Integer |
getVisibleRows()
Gets the number of rows to display at the same time.
|
void |
setContentsMargin(java.lang.Integer value)
Sets the amount of space between the contents border
and the actual contents of the view.
|
void |
setHeaderHeight(java.lang.Integer value)
Sets the height of the header in a
MonthRange view. |
void |
setHeaderShadowColor(java.awt.Color value)
Sets the color of the shadows 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 the headers.
|
void |
setHeaderStyle(java.util.EnumSet<MonthRangeHeaderStyles> value)
Sets the style of the
MonthRange view header. |
void |
setMargin(java.lang.Integer value)
Sets the amount of space between the outermost border
of the view and its contents.
|
void |
setMonthSpacing(java.lang.Integer value)
Sets the amount of space between adjacent months.
|
void |
setMonthsPerRow(java.lang.Integer value)
Sets the number of months to be displayed in a row.
|
void |
setNumberOfMonths(java.lang.Integer value)
Sets the number of months to display in the
MonthRange view. |
void |
setScrollInterval(java.lang.Integer value)
Sets the number of months to scroll the view back
or forth in time when a scroll button is pressed.
|
void |
setStyle(Style value)
Sets the appearance style used to paint calendar
elements that don't have a distinct style assigned to them.
|
void |
setTitleFormat(java.lang.String value)
Sets the string used to format the month titles.
|
void |
setTitleSeparator(java.lang.String value)
Sets the string used as a title separator in a
MonthRange view that displays
more than 1 month at a time. |
void |
setVisibleRows(java.lang.Integer value)
Sets the number of rows to display at the same time.
|
addChangeListener, removeChangeListener
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.lang.Integer getMonthsPerRow()
If this value multiplied by getVisibleRows()
is larger than
getNumberOfMonths()
, the calendar component displays scrollbars
letting users scroll the view up and down.
public void setMonthsPerRow(java.lang.Integer value)
If this value multiplied by getVisibleRows()
is larger than
getNumberOfMonths()
, the calendar component displays scrollbars
letting users scroll the view up and down.
value
- An integer value specifying how many months are displayed in a row
in the month range view. The allowed values range from 1 to 12.
Set to null to use the corresponding value from the current theme.public java.lang.Integer getVisibleRows()
public void setVisibleRows(java.lang.Integer value)
value
- A positive integer value specifying how many rows of month cells
to display. Set to null to use the corresponding value from the current theme.public java.lang.Integer getNumberOfMonths()
MonthRange
view.
If the number of months is larger than number of rows multiplied
by getMonthsPerRow()
, the calendar component displays scrollbar,
letting users scroll the view up and down.
public void setNumberOfMonths(java.lang.Integer value)
MonthRange
view.
If the number of months is larger than number of rows multiplied
by getMonthsPerRow()
, the calendar component displays scrollbar,
letting users scroll the view up and down.
value
- A positive integer value specifying how many months to display in
the view. 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 contents border and the time cells. 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 how many pixels
there are between the view contents and the outermost view border.
Set to null to use the corresponding value from the current theme.public java.lang.Integer getMonthSpacing()
public void setMonthSpacing(java.lang.Integer value)
value
- A non-negative integer value specifying how many pixels there
are between adjacent month cells. Set to null to use the corresponding
value from the current theme.public java.util.EnumSet<MonthRangeHeaderStyles> getHeaderStyle()
MonthRange
view header.MonthRangeHeaderStyles
constants.public void setHeaderStyle(java.util.EnumSet<MonthRangeHeaderStyles> value)
MonthRange
view header.value
- A set of the MonthRangeHeaderStyles
constants.
Set to null to use the corresponding value from the current theme.public java.lang.Integer getHeaderHeight()
MonthRange
view.
A value of 0 causes the calendar control to automatically calculate the header height based on the size of the header font.
public void setHeaderHeight(java.lang.Integer value)
MonthRange
view.
A value of 0 causes the calendar control to automatically calculate the header height based on the size of the header font.
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 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.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()
MonthRange
view that displays
more than 1 month at a time.
The format of the text displayed in the view's header is in the format
"<FirstDate><TitleSeparator><LastDate>",
where <FirstDate> and <LastDate> indicate the first and
the last visible dates in the calendar, formatted according to
getTitleFormat()
. The <TitleSeparator> represents
the value of this property. If getTitleSeparator()
is an empty string,
then the header's text is only "<FirstDate>".
public void setTitleSeparator(java.lang.String value)
MonthRange
view that displays
more than 1 month at a time.
The format of the text displayed in the view's header is in the format
"<FirstDate><TitleSeparator><LastDate>",
where <FirstDate> and <LastDate> indicate the first and
the last visible dates in the calendar, formatted according to
getTitleFormat()
. The <TitleSeparator> represents
the value of this property. If getTitleSeparator()
is an empty string,
then the header's text is only "<FirstDate>".
value
- A string containing the separator text. 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.Integer getScrollInterval()
public void setScrollInterval(java.lang.Integer value)
value
- A positive integer value specifying with how many months to scroll
the view. Set to null to use the corresponding value from the current theme.