public final class ListViewSettings extends ViewSettings
List
view.Modifier and Type | Method and Description |
---|---|
CellSettings |
getCellSettings()
Gets a
CellSettings object used to customize the
visualization of cells in the List view. |
java.lang.Integer |
getCellSpacing()
Gets the amount space between adjacent cells.
|
TimeUnit |
getCellUnits()
Gets the resolution of the list view.
|
java.lang.Integer |
getContentsMargin()
Gets the amount of space between the contents border
and the actual contents of the view.
|
java.lang.Boolean |
getEnableMilestoneMode()
Gets a value indicating whether milestone item rendering mode is
turned on.
|
java.lang.Boolean |
getEnableSnapping()
Gets a value indicating whether custom snapping is enabled.
|
java.lang.Boolean |
getEnableVirtualItemSpace()
Gets a value indicating whether items in the list view can be
scrolled through.
|
Brush |
getEvenWeeksBrush()
Gets the brush used to paint the background
of the contents of even weeks.
|
java.lang.String |
getFooterFormat()
Gets a string used to format the footer.
|
java.lang.Integer |
getFooterSize()
Gets the footer size, in pixels.
|
java.lang.Boolean |
getFreeDrag()
Gets a value indicating whether users can drag items anywhere
in the view, not only in the first unoccupied row.
|
java.lang.Integer |
getGroupHeaderSize()
Gets the size of the group header.
|
Style |
getGroupHeaderStyle()
Gets the appearance style used to paint
the headers of individual columns.
|
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 |
getHeaderSize()
Gets the header size in pixels.
|
java.util.EnumSet<ListViewHeaderStyles> |
getHeaderStyle()
Gets the style of the List view header.
|
Orientation |
getItemOrientation()
Gets a value indicating whether the items are
displayed horizontally, vertically or according to the
orientation of the view.
|
java.lang.String |
getMainHeaderFormat()
Gets a string used to format the main header.
|
java.lang.Integer |
getMainHeaderSize()
Gets or sets the main header size, in pixels.
|
java.lang.Integer |
getNumberOfCells()
Gets the total number of cells to be displayed
in the
List view. |
Brush |
getOddWeeksBrush()
Gets the brush used to paint the background
of the contents of odd weeks.
|
Orientation |
getOrientation()
Gets a value indicating whether the cells are
displayed horizontally or vertically.
|
java.lang.Boolean |
getRotateGroupHeaderTexts()
Gets a value indicating whether the group header texts
in a horizontal list view are rotated.
|
java.lang.Boolean |
getRotateHeaderTexts()
Gets a value indicating whether the header texts
in a horizontal list view are rotated.
|
java.lang.Integer |
getScrollStep()
Gets the number of units to scroll when the user
clicks the navigation buttons.
|
java.lang.Boolean |
getShowGroupHeader()
Gets a value indicating whether to display the resource grouping header.
|
java.lang.Boolean |
getShowNavigationButtons()
Gets a value indicating whether the
List view
displays navigation buttons. |
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 |
getSubHeaderDivisions()
Gets the number of divisions in the sub-header.
|
java.lang.Integer |
getSubHeaderSize()
Gets the subheader size in pixels.
|
java.lang.String |
getSubTitleFormat()
Gets a string used to format the subtitle texts.
|
java.lang.String |
getTitleFormat()
Gets a string used to format the cells titles.
|
java.lang.Integer |
getTotalLaneCount()
Gets the number of lanes in a
List view whose
getEnableVirtualItemSpace() is true. |
java.lang.Integer |
getVisibleCells()
Gets the number of cells visible at the same time.
|
java.lang.Integer |
getVisibleColumns()
Gets the number of visible group columns in a list view.
|
void |
setCellSpacing(java.lang.Integer value)
Sets the amount space between adjacent cells.
|
void |
setCellUnits(TimeUnit value)
Sets the resolution of the list view.
|
void |
setContentsMargin(java.lang.Integer value)
Sets the amount of space between the contents border
and the actual contents of the view.
|
void |
setEnableMilestoneMode(java.lang.Boolean value)
Sets a value indicating whether milestone item rendering mode is
turned on.
|
void |
setEnableSnapping(java.lang.Boolean value)
Sets a value indicating whether custom snapping is enabled.
|
void |
setEnableVirtualItemSpace(java.lang.Boolean value)
Sets a value indicating whether items in the list view can be
scrolled through.
|
void |
setEvenWeeksBrush(Brush value)
Sets the brush used to paint the background
of the contents of even weeks.
|
void |
setFooterFormat(java.lang.String value)
Sets a string used to format the footer.
|
void |
setFooterSize(java.lang.Integer value)
Gets the footer size, in pixels.
|
void |
setFreeDrag(java.lang.Boolean value)
Sets a value indicating whether users can drag items anywhere
in the view, not only in the first unoccupied row.
|
void |
setGroupHeaderSize(java.lang.Integer value)
Sets the size of the group header.
|
void |
setGroupHeaderStyle(Style value)
Sets the appearance style used to paint
the headers of individual columns.
|
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 |
setHeaderSize(java.lang.Integer value)
Sets the header size in pixels.
|
void |
setHeaderStyle(java.util.EnumSet<ListViewHeaderStyles> value)
Sets the style of the List view header.
|
void |
setItemOrientation(Orientation value)
Sets a value indicating whether the items are
displayed horizontally, vertically or according to the
orientation of the view.
|
void |
setMainHeaderFormat(java.lang.String value)
Sets a string used to format the main header.
|
void |
setMainHeaderSize(java.lang.Integer value) |
void |
setNumberOfCells(java.lang.Integer value)
Sets the total number of cells to be displayed
in the
List view. |
void |
setOddWeeksBrush(Brush value)
Sets the brush used to paint the background
of the contents of odd weeks.
|
void |
setOrientation(Orientation value)
Sets a value indicating whether the cells are
displayed horizontally or vertically.
|
void |
setRotateGroupHeaderTexts(java.lang.Boolean value)
Sets a value indicating whether the group header texts
in a horizontal list view are rotated.
|
void |
setRotateHeaderTexts(java.lang.Boolean value)
Sets a value indicating whether the header texts
in a horizontal list view are rotated.
|
void |
setScrollStep(java.lang.Integer value)
Sets the number of units to scroll when the user
clicks the navigation buttons.
|
void |
setShowGroupHeader(java.lang.Boolean value)
Sets a value indicating whether to display the resource grouping header.
|
void |
setShowNavigationButtons(java.lang.Boolean value)
Sets a value indicating whether the
List view
displays navigation buttons. |
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 |
setSubHeaderDivisions(java.lang.Integer value)
Sets the number of divisions in the sub-header.
|
void |
setSubHeaderSize(java.lang.Integer value)
Sets the subheader size in pixels.
|
void |
setSubTitleFormat(java.lang.String value)
Sets a string used to format the subtitle texts.
|
void |
setTitleFormat(java.lang.String value)
Sets a string used to format the cells titles.
|
void |
setTotalLaneCount(java.lang.Integer value)
Sets the number of lanes in a
List view whose
getEnableVirtualItemSpace() is true. |
void |
setVisibleCells(java.lang.Integer value)
Sets the number of cells visible at the same time.
|
void |
setVisibleColumns(java.lang.Integer value)
Sets the number of visible group columns in a list view.
|
addChangeListener, removeChangeListener
public CellSettings getCellSettings()
CellSettings
object used to customize the
visualization of cells in the List
view.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 getGroupHeaderStyle()
Style
object specifying the style
of the column headers. This property cannot be null.public void setGroupHeaderStyle(Style value)
value
- A Style
object specifying the style
of the column headers. This property cannot be null.public TimeUnit getCellUnits()
TimeUnit
constants.public void setCellUnits(TimeUnit value)
value
- One of the TimeUnit
constants.
Set to null to use the corresponding value from the current theme.public java.lang.Integer getNumberOfCells()
List
view.
This value cannot be less than 1 or less than the number of
visible days as specified by getVisibleCells()
.
public void setNumberOfCells(java.lang.Integer value)
List
view.
This value cannot be less than 1 or less than the number of
visible days as specified by getVisibleCells()
.
value
- An integer value specifying how many days to display.
Set to null to use the corresponding value from the current theme.public java.lang.Integer getVisibleCells()
This value cannot be less than 1 or less than the total number of days
available in the view, as specified by getNumberOfCells()
.
public void setVisibleCells(java.lang.Integer value)
This value cannot be less than 1 or less than the total number of days
available in the view, as specified by getNumberOfCells()
.
value
- A positive integer value specifying how many days to display
simultaneously in the list view. Set to null to use the corresponding
value from the current theme.public java.util.EnumSet<ListViewHeaderStyles> getHeaderStyle()
ListViewHeaderStyles
constants.public void setHeaderStyle(java.util.EnumSet<ListViewHeaderStyles> value)
value
- One of the ListViewHeaderStyles
constants.
Set to null to use the corresponding value from the current theme.public java.lang.Integer getHeaderSize()
This value specifies the header width if getOrientation()
is
Horizontal
or the height if
getOrientation()
is Vertical
.
public void setHeaderSize(java.lang.Integer value)
This value specifies the header width if getOrientation()
is
Horizontal
or the height if
getOrientation()
is Vertical
.
value
- A non-negative integer value specifying the header size.
A value of 0 hides the header. Set to null to use the corresponding
value from the current theme.public java.lang.Integer getMainHeaderSize()
public void setMainHeaderSize(java.lang.Integer value)
public java.lang.Integer getFooterSize()
public void setFooterSize(java.lang.Integer value)
public java.lang.Integer getSubHeaderSize()
This value specifies the header width if getOrientation()
is
Horizontal
or the height if
getOrientation()
is Vertical
.
public void setSubHeaderSize(java.lang.Integer value)
This value specifies the header width if getOrientation()
is
Horizontal
or the height if
getOrientation()
is Vertical
.
value
- A non-negative integer value specifying the subheader size.
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 defining the border space in pixels.
Set to null to use the corresponding value from the current theme.public Orientation getOrientation()
If this property is set to Horizontal
,
the view header is displayed at the top and the day cells are
arranged in a horizontal row underneath it. If set to
Vertical
, the header is displayed
on the left side and the days are arranged in a vertical row on the right.
Orientation
enumeration.public void setOrientation(Orientation value)
If this property is set to Horizontal
,
the view header is displayed at the top and the day cells are
arranged in a horizontal row underneath it. If set to
Vertical
, the header is displayed
on the left side and the days are arranged in a vertical row on the right.
value
- One of the Orientation
constants.
Set to null to use the corresponding value from the current theme.public Orientation getItemOrientation()
Items are usually oriented according to the view's orientation as
specified by getOrientation()
. That is, items are horizontal
in a horizontal List
view and vice versa.
The orientation of the items can be explicitly specified by using
this property.
Orientation
enumeration.public void setItemOrientation(Orientation value)
Items are usually oriented according to the view's orientation as
specified by getOrientation()
. That is, items are horizontal
in a horizontal List
view and vice versa.
The orientation of the items can be explicitly specified by using
this property.
value
- One of the Orientation
constants.
Set to null to use the corresponding value from the current theme.public Brush getOddWeeksBrush()
Brush
-derived class.public void setOddWeeksBrush(Brush value)
value
- An instance of a Brush
-derived class.
Set to null to use the corresponding value from the current theme.public Brush getEvenWeeksBrush()
Brush
-derived class.public void setEvenWeeksBrush(Brush value)
value
- An instance of a Brush
-derived class.
Set to null to use the corresponding value from the current theme.public java.lang.Integer getCellSpacing()
public void setCellSpacing(java.lang.Integer value)
value
- A non-negative integer value specifying how much space to leave
(expressed 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 getSubTitleFormat()
In addition to the standard specifiers, the "w1" format can be used to display only the first letter of the day of the week (that is, 'M' for Monday, 'T' for Tuesday, and so on). This specifier cannot be combined with other specifiers, it can be used only by its own.
public void setSubTitleFormat(java.lang.String value)
In addition to the standard specifiers, the "w1" format can be used to display only the first letter of the day of the week (that is, 'M' for Monday, 'T' for Tuesday, and so on). This specifier cannot be combined with other specifiers, it can be used only by its own.
value
- A string specifying the display format. Set to null to use
the corresponding value from the current theme.public java.lang.String getMainHeaderFormat()
public void setMainHeaderFormat(java.lang.String value)
public java.lang.String getFooterFormat()
public void setFooterFormat(java.lang.String value)
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 shadow color.
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 the distance between a header and
its shadow. The allowed values range from 1 to 5. Set to null to use
the corresponding value from the current theme.public java.lang.Boolean getRotateHeaderTexts()
public void setRotateHeaderTexts(java.lang.Boolean value)
value
- true to display the header text rotated; otherwise, false.
Set to null to use the corresponding value from the current theme.public java.lang.Boolean getRotateGroupHeaderTexts()
public void setRotateGroupHeaderTexts(java.lang.Boolean value)
public java.lang.Integer getVisibleColumns()
This value is used only when the view is grouped. Otherwise, the number of columns is always 1.
public void setVisibleColumns(java.lang.Integer value)
This value is used only when the view is grouped. Otherwise, the number of columns is always 1.
value
- A positive integer value specifying the number of columns visible
at the same time. Set to null to use the corresponding value from the current theme.public java.lang.Boolean getShowGroupHeader()
Boolean
value.public void setShowGroupHeader(java.lang.Boolean value)
value
- A Boolean
value. Set to null to use the corresponding
value from the current theme.public java.lang.Integer getGroupHeaderSize()
A value of 0 causes the calendar to automatically calculate a header size based on the size of the header font.
public void setGroupHeaderSize(java.lang.Integer value)
A value of 0 causes the calendar to automatically calculate a header size based on the size of the header font.
value
- A non-negative integer value specifying the size of the header in pixels.
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 getFreeDrag()
Set this property to true to disable the default item layout
algorithm, where colliding items are arranged relative to each
other according to their start and end times and their Priority
.
Turning this property on will allow users to move items anywhere
within the view.
The position of an item within the view can be obtained and set
programmatically through the use of the Calendar.getItemListLane(com.mindfusion.scheduling.model.Item)
and Calendar.setItemListLane(com.mindfusion.scheduling.model.Item, int)
methods.
Boolean
value.public void setFreeDrag(java.lang.Boolean value)
Set this property to true to disable the default item layout
algorithm, where colliding items are arranged relative to each
other according to their start and end times and their Priority
.
Turning this property on will allow users to move items anywhere
within the view.
The position of an item within the view can be obtained and set
programmatically through the use of the Calendar.getItemListLane(com.mindfusion.scheduling.model.Item)
and Calendar.setItemListLane(com.mindfusion.scheduling.model.Item, int)
methods.
value
- A Boolean
value. Set to null to use the corresponding
value from the current theme.public java.lang.Boolean getEnableVirtualItemSpace()
Use this property to override the default behavior of the vertical
scrollbar (in a horizontal List
view) or
the horizontal scrollbar (in a vertical List
view). When this property is enabled, the appropriate scrollbar will
scroll through the items that are not visible within the view (due
to insufficient space) rather than scroll through the cells associated
with resources in a grouped List
view.
Boolean
value.public void setEnableVirtualItemSpace(java.lang.Boolean value)
Use this property to override the default behavior of the vertical
scrollbar (in a horizontal List
view) or
the horizontal scrollbar (in a vertical List
view). When this property is enabled, the appropriate scrollbar will
scroll through the items that are not visible within the view (due
to insufficient space) rather than scroll through the cells associated
with resources in a grouped List
view.
value
- A Boolean
value. Set to null to use the corresponding
value from the current theme.public java.lang.Integer getTotalLaneCount()
List
view whose
getEnableVirtualItemSpace()
is true.
When this property is set to 0, the item scrollbar is automatically adjusted so that it covers all existing items. Otherwise the item scrollbar is adjusted so that it covers the specified number of lanes.
public void setTotalLaneCount(java.lang.Integer value)
List
view whose
getEnableVirtualItemSpace()
is true.
When this property is set to 0, the item scrollbar is automatically adjusted so that it covers all existing items. Otherwise the item scrollbar is adjusted so that it covers the specified number of lanes.
value
- A non-negative integer value specifying the number of lanes in the view.
Set to null to use the corresponding value from the current theme.public java.lang.Boolean getShowNavigationButtons()
List
view
displays navigation buttons.
The size of the buttons can be controlled through the Calendar.setButtonSize(int)
method of the Calendar
class. The amount of units to scroll can be specified
through setScrollStep(java.lang.Integer)
property.
Boolean
value.public void setShowNavigationButtons(java.lang.Boolean value)
List
view
displays navigation buttons.
The size of the buttons can be controlled through the Calendar.setButtonSize(int)
method of the Calendar
class. The amount of units to scroll can be specified
through setScrollStep(java.lang.Integer)
property.
value
- A Boolean
value. Set to null to use the corresponding
value from the current theme.public java.lang.Integer getScrollStep()
This property specifies the amount of units (as specified by
getCellUnits()
) to scroll back and forth when using the
navigation buttons in the List
view.
public void setScrollStep(java.lang.Integer value)
This property specifies the amount of units (as specified by
getCellUnits()
) to scroll back and forth when using the
navigation buttons in the List
view.
value
- An integer value specifying the number of units to scroll.
Set to null to use the corresponding value from the current theme.public java.lang.Integer getSubHeaderDivisions()
The value of this property is used only when the subheader of the
List
view is displayed (as specified by
getHeaderStyle()
). The value specifies the number of cells
in the subheader. The date in each cell is calculated automatically
and is displayed according to getSubTitleFormat()
.
public void setSubHeaderDivisions(java.lang.Integer value)
The value of this property is used only when the subheader of the
List
view is displayed (as specified by
getHeaderStyle()
). The value specifies the number of cells
in the subheader. The date in each cell is calculated automatically
and is displayed according to getSubTitleFormat()
.
value
- An integer value specifying the number of cells in the subheader.
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 getEnableMilestoneMode()
Boolean
value.public void setEnableMilestoneMode(java.lang.Boolean value)
value
- A Boolean
value. Set to null to use the corresponding
value from the current theme.