public final class ItemSettings
extends java.lang.Object
Modifier and Type | Method and Description |
---|---|
void |
addChangeListener(ChangeListener listener)
Adds a
ChangeListener to the settings. |
java.lang.Boolean |
getCapIncompleteSegments()
Gets a value indicating whether to cap incomplete item segments.
|
java.lang.Boolean |
getEnableDefaultRendering()
Gets a value indicating whether the default item rendering is enabled.
|
java.lang.Integer |
getHeaderSize()
Gets the size of the item header for non all-day items in
the
Timetable view. |
java.lang.Boolean |
getItemsVisible()
Gets a value indicating whether to display schedule items in the calendar.
|
java.lang.Integer |
getMoveBandSize()
Gets the size of the move band of items in the Timetable view.
|
java.lang.Integer |
getPadding()
Gets the amount of space between each item and the
frame lines of the calendar cell that contains the item.
|
java.lang.Integer |
getPaddingBottom()
Gets the amount of space between the bottom side of an item and
bottom frame line of the calendar cell that contains the item.
|
java.lang.Integer |
getPaddingLeft()
Gets the amount of space between the left side of an item
and left frame line of the calendar cell that contains the item.
|
java.lang.Integer |
getPaddingRight()
Gets the amount of space between the right side of an item and
right frame line of the calendar cell that contains the item.
|
java.lang.Integer |
getPaddingTop()
Gets the amount of space between the top side of an item
and top frame line of the calendar cell that contains the item.
|
Style |
getPointedItemStyle()
Gets the
Style used to paint items when they are pointed with the mouse. |
Style |
getPointedSelectedItemStyle()
Gets the
Style used to paint items when they are
pointed with the mouse and selected at the same time. |
java.lang.Integer |
getResizeBandSize()
Gets the size of the bands used to resize an item in a Timetable view.
|
java.lang.Boolean |
getScaleClocks()
Gets a value indicating whether the clock icons are
scaled proportionally to the size of the items.
|
Style |
getSelectedItemStyle()
Gets the
Style used to paint selected schedule items. |
java.awt.Color |
getShadowColor()
Gets the color of the shadow cast by the items.
|
java.lang.Integer |
getShadowOffset()
Gets the offset of the shadows from the items.
|
ShadowStyle |
getShadowStyle()
Gets the style of the shadow cast by the items.
|
ShowClocks |
getShowClocks()
Gets whether and when the clocks displaying
the items' start and end time are shown.
|
java.lang.Boolean |
getShowContinuationArrows()
Gets a value indicating whether to display small arrows at the
beginning or at the end of each incomplete segment to indicate
that the schedule item continues in an adjacent calendar cell.
|
java.lang.Boolean |
getShowMoreItemsCue()
Gets a value indicating whether to display a 'more items' icon
in a calendar cell which isn't big enough to contain all of its items.
|
java.lang.Boolean |
getShowRecurrenceExceptionIcons()
Gets a value indicating whether the icon of recurrence exception items is displayed.
|
java.lang.Boolean |
getShowRecurrenceIcons()
Gets a value indicating whether the icon of recurring items is displayed.
|
java.lang.Boolean |
getShowReminderIcons()
Gets a value indicating whether the reminder icon of items is displayed.
|
java.lang.Integer |
getSize()
Gets the size of schedule items drawn in the calendar.
|
java.lang.Integer |
getSpacing()
Gets the amount of space between adjacent items.
|
Style |
getStyle()
Gets the
Style used to paint schedule items that
don't have a distinct style assigned to them. |
java.lang.Boolean |
getUseExtendedStyles()
Gets a value indicating whether the appropriate styles
are used when an item is pointed with the mouse.
|
java.lang.Boolean |
getUseStyledText()
Gets a value indicating whether formatting tags such as
<b> and <i> are taken into consideration in
the items' description text.
|
void |
removeChangeListener(ChangeListener listener)
Removes the specified
ChangeListener from the settings. |
void |
setCapIncompleteSegments(java.lang.Boolean value)
Sets a value indicating whether to cap incomplete item segments.
|
void |
setEnableDefaultRendering(java.lang.Boolean value)
Sets a value indicating whether the default item rendering is enabled.
|
void |
setHeaderSize(java.lang.Integer value)
Sets the size of the item header for non all-day items in
the
Timetable view. |
void |
setItemsVisible(java.lang.Boolean value)
Sets a value indicating whether to display schedule items in the calendar.
|
void |
setMoveBandSize(java.lang.Integer value)
Sets the size of the move band of items in the
Timetable view. |
void |
setPadding(java.lang.Integer value)
Sets the amount of space between each item and the
frame lines of the calendar cell that contains the item.
|
void |
setPaddingBottom(java.lang.Integer value)
Sets the amount of space between the bottom side of an item and
bottom frame line of the calendar cell that contains the item.
|
void |
setPaddingLeft(java.lang.Integer value)
Sets the amount of space between the left side of an item
and left frame line of the calendar cell that contains the item.
|
void |
setPaddingRight(java.lang.Integer value)
Sets the amount of space between the right side of an item and
right frame line of the calendar cell that contains the item.
|
void |
setPaddingTop(java.lang.Integer value)
Sets the amount of space between the top side of an item
and top frame line of the calendar cell that contains the item.
|
void |
setPointedItemStyle(Style value)
Sets the
Style used to paint items when they are pointed with the mouse. |
void |
setPointedSelectedItemStyle(Style value)
Sets the
Style used to paint items when they are
pointed with the mouse and selected at the same time. |
void |
setResizeBandSize(java.lang.Integer value)
Sets the size of the bands used to resize an item in a Timetable view.
|
void |
setScaleClocks(java.lang.Boolean value)
Sets a value indicating whether the clock icons are
scaled proportionally to the size of the items.
|
void |
setSelectedItemStyle(Style value)
Sets the
Style used to paint selected schedule items. |
void |
setShadowColor(java.awt.Color value)
Sets the color of the shadow cast by the items.
|
void |
setShadowOffset(java.lang.Integer value)
Sets the offset of the shadows from the items.
|
void |
setShadowStyle(ShadowStyle value)
Sets the style of the shadow cast by the items.
|
void |
setShowClocks(ShowClocks value)
Sets whether and when the clocks displaying
the items' start and end time are shown.
|
void |
setShowContinuationArrows(java.lang.Boolean value)
Sets a value indicating whether to display small arrows at the
beginning or at the end of each incomplete segment to indicate
that the schedule item continues in an adjacent calendar cell.
|
void |
setShowMoreItemsCue(java.lang.Boolean value)
Sets a value indicating whether to display a 'more items' icon
in a calendar cell which isn't big enough to contain all of its items.
|
void |
setShowRecurrenceExceptionIcons(java.lang.Boolean value)
Sets a value indicating whether the icon of recurrence exception items is displayed.
|
void |
setShowRecurrenceIcons(java.lang.Boolean value)
Sets a value indicating whether the icon of recurring items is displayed.
|
void |
setShowReminderIcons(java.lang.Boolean value)
Sets a value indicating whether the reminder icon of items is displayed.
|
void |
setSize(java.lang.Integer value)
Sets the size of schedule items drawn in the calendar.
|
void |
setSpacing(java.lang.Integer value)
Sets the amount of space between adjacent items.
|
void |
setStyle(Style value)
Sets the
Style used to paint schedule items that
don't have a distinct style assigned to them. |
void |
setUseExtendedStyles(java.lang.Boolean value)
Sets a value indicating whether the appropriate styles
are used when an item is pointed with the mouse.
|
void |
setUseStyledText(java.lang.Boolean value)
Sets a value indicating whether formatting tags such as
<b> and <i> are taken into consideration in
the items' description text.
|
public Style getStyle()
Style
used to paint schedule items that
don't have a distinct style assigned to them.Style
object defining the appearance of schedule items.
This property cannot be null.public void setStyle(Style value)
Style
used to paint schedule items that
don't have a distinct style assigned to them.value
- A Style
object defining the appearance of schedule items.
This property cannot be null.public Style getSelectedItemStyle()
Style
used to paint selected schedule items.Style
object defining the appearance of schedule items.public void setSelectedItemStyle(Style value)
Style
used to paint selected schedule items.value
- A Style
object defining the appearance of schedule items.
This property cannot be null.public Style getPointedItemStyle()
Style
used to paint items when they are pointed with the mouse.
This property is ignored when getUseExtendedStyles()
is false.
Style
object defining the appearance of schedule items when
they are pointed with the mouse. This property cannot be null.public void setPointedItemStyle(Style value)
Style
used to paint items when they are pointed with the mouse.
This property is ignored when getUseExtendedStyles()
is false.
value
- A Style
object defining the appearance of schedule items when
they are pointed with the mouse.public Style getPointedSelectedItemStyle()
Style
used to paint items when they are
pointed with the mouse and selected at the same time.
This property is ignored when getUseExtendedStyles()
is false.
Style
object defining the appearance of schedule items when
they are pointed with the mouse and selected at the same time.public void setPointedSelectedItemStyle(Style value)
Style
used to paint items when they are
pointed with the mouse and selected at the same time.
This property is ignored when getUseExtendedStyles()
is false.
value
- A Style
object defining the appearance of schedule items when
they are pointed with the mouse and selected at the same time. This property cannot be null.public java.lang.Integer getSize()
This property specifies the height of horizontal items or the width of vertical items. The items length is defined by their start time and duration. The property is ignored for items drawn in timetable view.
public void setSize(java.lang.Integer value)
This property specifies the height of horizontal items or the width of vertical items. The items length is defined by their start time and duration. The property is ignored for items drawn in timetable view.
value
- A non-negative integer value specifying items width or height in pixels.
Set to null to use the corresponding value from the current theme.public java.lang.Integer getSpacing()
public void setSpacing(java.lang.Integer value)
value
- A non-negative integer value specifying how many pixels there are between
adjacent items. Set to null to use the corresponding value from the current theme.public java.lang.Integer getPadding()
In a Timetable
view this is
the distance between consecutive items.
public void setPadding(java.lang.Integer value)
In a Timetable
view this is
the distance between consecutive items.
value
- A non-negative integer value specifying how many pixels there are left
between items and the time cells containing them. Set to null to use the
corresponding value from the current theme.public java.lang.Integer getPaddingLeft()
public void setPaddingLeft(java.lang.Integer value)
value
- An integer value specifying the distance between the left side of
an item and the left side of the cell containing it. Set to null to use
the corresponding value from the current theme. Set to -1 to indicate that
this property should be ignored and the value of Padding
should be regarded instead.public java.lang.Integer getPaddingTop()
public void setPaddingTop(java.lang.Integer value)
value
- An integer value specifying the distance between the top side of
an item and the top side of the cell containing it. Set to null to use the
corresponding value from the current theme. Set to -1 to indicate that this
property should be ignored and the value of Padding
should be regarded instead.public java.lang.Integer getPaddingRight()
public void setPaddingRight(java.lang.Integer value)
value
- An integer value specifying the distance between the right side
of an item and the right side of the cell containing it. Set to null to use
the corresponding value from the current theme. Set to -1 to indicate that
this property should be ignored and the value of Padding
should be regarded instead.public java.lang.Integer getPaddingBottom()
public void setPaddingBottom(java.lang.Integer value)
value
- An integer value specifying the distance between the bottom side
of an item and the bottom side of the cell containing it. Set to null to use
the corresponding value from the current theme. Set to -1 to indicate that
this property should be ignored and the value of Padding
should be regarded instead.public java.lang.Boolean getShowMoreItemsCue()
public void setShowMoreItemsCue(java.lang.Boolean value)
value
- true to display the 'more items' cue icon when there are items
not visible in the current viewport; otherwise, false. Set to null to
use the corresponding value from the current theme.public java.lang.Boolean getShowContinuationArrows()
public void setShowContinuationArrows(java.lang.Boolean value)
value
- true to display arrow icons when an item continues in next time cell;
otherwise, false. Set to null to use the corresponding value from the current theme.public java.lang.Boolean getCapIncompleteSegments()
This property is ignored for non all-day items in
the Timetable
view.
public void setCapIncompleteSegments(java.lang.Boolean value)
This property is ignored for non all-day items in
the Timetable
view.
value
- true to cap incomplete items segments; otherwise, false.
Set to null to use the corresponding value from the current theme.public java.lang.Boolean getItemsVisible()
public void setItemsVisible(java.lang.Boolean value)
value
- true to display schedule items; otherwise, false.
Set to null to use the corresponding value from the current theme.public ShadowStyle getShadowStyle()
ShadowStyle
constants.public void setShadowStyle(ShadowStyle value)
value
- One of the ShadowStyle
constants.
Set to null to use the corresponding value from the current theme.public java.awt.Color getShadowColor()
public void setShadowColor(java.awt.Color value)
value
- A Color object specifying the color of item shadows.
Set to null to use the corresponding value from the current theme.public java.lang.Integer getShadowOffset()
public void setShadowOffset(java.lang.Integer value)
value
- An integer value specifying with how many pixels an item's shadow
is offset from the item. The allowed values range from 1 to 5.
Set to null to use the corresponding value from the current theme.public java.lang.Integer getMoveBandSize()
public void setMoveBandSize(java.lang.Integer value)
Timetable
view.value
- A non-negative integer value specifying the band size in pixels.
Set to null to use the corresponding value from the current theme.public java.lang.Integer getResizeBandSize()
public void setResizeBandSize(java.lang.Integer value)
value
- An integer value specifying the bands' size in pixels. The minimal
allowed value is 2. Set to null to use the corresponding value from the current theme.public java.lang.Integer getHeaderSize()
Timetable
view.public void setHeaderSize(java.lang.Integer value)
Timetable
view.value
- A non-negative integer value specifying the size of the item header.
Set to null to use the corresponding value from the current theme.
Set to 0 to hide the item header.public java.lang.Boolean getUseStyledText()
Styled text allows applying various attributes to the characters it contains. Attributes are specified using HTML-like formatting tags embedded in the raw text.
public void setUseStyledText(java.lang.Boolean value)
Styled text allows applying various attributes to the characters it contains. Attributes are specified using HTML-like formatting tags embedded in the raw text.
value
- true to enable the use of formatting tags in the item's description;
otherwise, false. Set to null to use the corresponding value from the current theme.public ShowClocks getShowClocks()
ShowClocks
constants.public void setShowClocks(ShowClocks value)
value
- One of the ShowClocks
constants or null.
Set to null to use the corresponding value from the current theme.public java.lang.Boolean getUseExtendedStyles()
If this value is false, the pointed styles (that is,
getPointedItemStyle()
and getPointedSelectedItemStyle()
) are ignored.
public void setUseExtendedStyles(java.lang.Boolean value)
If this value is false, the pointed styles (that is,
getPointedItemStyle()
and getPointedSelectedItemStyle()
) are ignored.
value
- A Boolean value. Set to null to use the corresponding value from the current theme.public java.lang.Boolean getShowRecurrenceIcons()
public void setShowRecurrenceIcons(java.lang.Boolean value)
value
- true to display an icon for recurring items; otherwise, false.
Set to null to use the corresponding value from the current theme.public java.lang.Boolean getShowRecurrenceExceptionIcons()
public void setShowRecurrenceExceptionIcons(java.lang.Boolean value)
value
- true to display an icon for the exceptions of recurring items; otherwise, false.
Set to null to use the corresponding value from the current theme.public java.lang.Boolean getShowReminderIcons()
public void setShowReminderIcons(java.lang.Boolean value)
value
- true to display an icon for items that have a reminder; otherwise, false.
Set to null to use the corresponding value from the current theme.public java.lang.Boolean getScaleClocks()
public void setScaleClocks(java.lang.Boolean value)
value
- A Boolean value. Set to null to use the corresponding value from the current theme.public java.lang.Boolean getEnableDefaultRendering()
You can disable this property when you perform complete custom drawing of your items and don't want the Calendar control to perform default painting. This way you can substantially optimize the performance of your application.
public void setEnableDefaultRendering(java.lang.Boolean value)
You can disable this property when you perform complete custom drawing of your items and don't want the Calendar control to perform default painting. This way you can substantially optimize the performance of your application.
value
- A Boolean value specifying whether the control should paint schedule items.
Set to null to use the corresponding value from the current theme.public void addChangeListener(ChangeListener listener)
ChangeListener
to the settings.listener
- The ChangeListener
to be added.public void removeChangeListener(ChangeListener listener)
ChangeListener
from the settings.listener
- The listener to be removed.