com.telerik.widget.calendar.dayview

Class AllDayEventsViewStyle

java.lang.Object

com.telerik.widget.calendar.dayview.AllDayEventsViewStyle

public class AllDayEventsViewStyle
extends Object

This class contains properties which allows you to change the style of an AllDayEventsView.

Constructor Summary

Constructors

Constructor and Description
AllDayEventsViewStyle(CalendarDayView owner) Constructor

Method Summary

Modifier and Type	Method and Description
int	getAllDayGravity() Gets the gravity for the all day label that notates the all day events container.
int	getAllDayOffsetHorizontal() Gets a value in pixels which represents the horizontal offset for the all day label that notates the all day events container.
int	getAllDayOffsetVertical() Gets a value in pixels which represents the vertical offset for the all day label that notates the all day events container.
String	getAllDayText() Gets the text for the all day label that notates the all day events container.
int	getAllDayTextColor() Gets the text color for the all day label that notates the all day events container.
boolean	getAllDayTextIsVisible() Gets a value indicating whether the all day label that notates the all day events container should be visible or not.
int	getAllDayTextSize() Gets a value in scaled pixels (sp) that represents the text size used by the all day label that notates the all day events container.
int	getBackgroundColor() Gets the background color for all day events container.
int	getElevation() Gets the elevation for all day events container.
int	getEventsSpacing() Gets a value in pixels that should be used between the all day events in the all day events view.
int	getMaxColumns() Gets the maximum number of columns that will be used to layout the all day events.
float	getMaxVisibleEventRows() Gets a value that represents how many rows will be visible in the all day events view (given that there are enough events to fill these rows).
int	getMinimumHeight() Gets the minimum height for all day events container.
void	setAllDayGravity(int allDayGravity) Sets the gravity for the all day label that notates the all day events container.
void	setAllDayOffsetHorizontal(int allDayOffsetHorizontal) Sets a value in pixels which represents the horizontal offset for the all day label that notates the all day events container.
void	setAllDayOffsetVertical(int allDayOffsetVertical) Sets a value in pixels which represents the vertical offset for the all day label that notates the all day events container.
void	setAllDayText(String allDayText) Sets the text for the all day label that notates the all day events container.
void	setAllDayTextColor(int allDayTextColor) Sets the text color for the all day label that notates the all day events container.
void	setAllDayTextIsVisible(boolean allDayTextIsVisible) Sets a value indicating whether the all day label that notates the all day events container should be visible or not.
void	setAllDayTextSize(int allDayTextSize) Sets a value in scaled pixels (sp) that represents the text size used by the all day label that notates the all day events container.
void	setBackgroundColor(int backgroundColor) Sets a background color for all day events container.
void	setElevation(int elevation) Sets the elevation for all day events container.
void	setEventsSpacing(int eventsSpacing) Sets a value in pixels that will be used between the all day events in the all day events view.
void	setMaxColumns(int maxColumns) Sets the maximum number of columns that will be used to layout the all day events.
void	setMaxVisibleEventRows(float maxVisibleEventRows) Sets a value that represents how many rows will be visible in the all day events view (given that there are enough events to fill these rows).
void	setMinimumHeight(int minimumHeight) Sets a value for minimum height for all day events container.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

AllDayEventsViewStyle

public AllDayEventsViewStyle(CalendarDayView owner)

Constructor

Parameters:

owner - the dayView that will use this style

Method Detail

getBackgroundColor

public int getBackgroundColor()

Gets the background color for all day events container.

Returns:

the current all day views container background color

See Also:

CalendarDayViewItem.makeAllDayEventsContainer(Context)

setBackgroundColor

public void setBackgroundColor(int backgroundColor)

Sets a background color for all day events container.

Parameters:

backgroundColor - the new all day views container background color

See Also:

CalendarDayViewItem.makeAllDayEventsContainer(Context)

getMinimumHeight

public int getMinimumHeight()

Gets the minimum height for all day events container. Default value is LinearLayout.LayoutParams.WRAP_CONTENT.

Returns:

the current minimum height for day views container

See Also:

CalendarDayViewItem.makeAllDayEventsContainer(Context)

setMinimumHeight

public void setMinimumHeight(int minimumHeight)

Sets a value for minimum height for all day events container. Default value is LinearLayout.LayoutParams.WRAP_CONTENT.

Parameters:

minimumHeight - the new minimum height for day views container

See Also:

CalendarDayViewItem.makeAllDayEventsContainer(Context)

getElevation

public int getElevation()

Gets the elevation for all day events container. This will have a visible effect only on API21 or higher.

Returns:

the current elevation for day views container

See Also:

CalendarDayViewItem.makeAllDayEventsContainer(Context)

setElevation

public void setElevation(int elevation)

Sets the elevation for all day events container. This will have a visible effect only on API21 or higher.

Parameters:

elevation - the current elevation for day views container

See Also:

CalendarDayViewItem.makeAllDayEventsContainer(Context)

getAllDayText

public String getAllDayText()

Gets the text for the all day label that notates the all day events container. Default value is "ALL-DAY".

Returns:

the current text for the all day label

See Also:

CalendarDayViewItem.makeAllDayLabel(Context)

setAllDayText

public void setAllDayText(String allDayText)

Sets the text for the all day label that notates the all day events container. Default value is "ALL-DAY".

Parameters:

allDayText - the new text for the all day label

See Also:

CalendarDayViewItem.makeAllDayLabel(Context)

getAllDayGravity

public int getAllDayGravity()

Gets the gravity for the all day label that notates the all day events container. Default value is Gravity.CENTER_VERTICAL.

Returns:

the current gravity for the all day label

See Also:

CalendarDayViewItem.makeAllDayLabel(Context)

setAllDayGravity

public void setAllDayGravity(int allDayGravity)

Sets the gravity for the all day label that notates the all day events container. Default value is Gravity.CENTER_VERTICAL.

Parameters:

allDayGravity - the new gravity for the all day label

See Also:

CalendarDayViewItem.makeAllDayLabel(Context)

getAllDayOffsetHorizontal

public int getAllDayOffsetHorizontal()

Gets a value in pixels which represents the horizontal offset for the all day label that notates the all day events container. Default value is converted from dips based on the current device density.

Returns:

the current horizontal offset for the all day label

See Also:

CalendarDayViewItem.makeAllDayLabel(Context)

setAllDayOffsetHorizontal

public void setAllDayOffsetHorizontal(int allDayOffsetHorizontal)

Sets a value in pixels which represents the horizontal offset for the all day label that notates the all day events container. Default value is converted from dips based on the current device density.

Parameters:

allDayOffsetHorizontal - the new horizontal offset for the all day label

See Also:

CalendarDayViewItem.makeAllDayLabel(Context)

getAllDayOffsetVertical

public int getAllDayOffsetVertical()

Gets a value in pixels which represents the vertical offset for the all day label that notates the all day events container. Default value is converted from dips based on the current device density.

Returns:

the current vertical offset for the all day label

See Also:

CalendarDayViewItem.makeAllDayLabel(Context)

setAllDayOffsetVertical

public void setAllDayOffsetVertical(int allDayOffsetVertical)

Sets a value in pixels which represents the vertical offset for the all day label that notates the all day events container. Default value is converted from dips based on the current device density.

Parameters:

allDayOffsetVertical - the new vertical offset for the all day label

See Also:

CalendarDayViewItem.makeAllDayLabel(Context)

getAllDayTextColor

public int getAllDayTextColor()

Gets the text color for the all day label that notates the all day events container.

Returns:

the current text color for the all day label

See Also:

CalendarDayViewItem.makeAllDayLabel(Context)

setAllDayTextColor

public void setAllDayTextColor(int allDayTextColor)

Sets the text color for the all day label that notates the all day events container.

Parameters:

allDayTextColor - the new text color for the all day label

See Also:

CalendarDayViewItem.makeAllDayLabel(Context)

getAllDayTextIsVisible

public boolean getAllDayTextIsVisible()

Gets a value indicating whether the all day label that notates the all day events container should be visible or not. Default value is `true`.

Returns:

whether the the all day label should be visible

See Also:

CalendarDayViewItem.makeAllDayLabel(Context)

setAllDayTextIsVisible

public void setAllDayTextIsVisible(boolean allDayTextIsVisible)

Sets a value indicating whether the all day label that notates the all day events container should be visible or not. Default value is `true`.

Parameters:

allDayTextIsVisible - whether the the all day label should be visible

See Also:

CalendarDayViewItem.makeAllDayLabel(Context)

getAllDayTextSize

public int getAllDayTextSize()

Gets a value in scaled pixels (sp) that represents the text size used by the all day label that notates the all day events container.

Returns:

the all day label text size in scaled pixels (sp)

See Also:

CalendarDayViewItem.makeAllDayLabel(Context)

setAllDayTextSize

public void setAllDayTextSize(int allDayTextSize)

Sets a value in scaled pixels (sp) that represents the text size used by the all day label that notates the all day events container.

Parameters:

allDayTextSize - the all day label text size in scaled pixels (sp)

See Also:

CalendarDayViewItem.makeAllDayLabel(Context)

getMaxColumns

public int getMaxColumns()

Gets the maximum number of columns that will be used to layout the all day events. Default value is 2.

Returns:

the max columns used by the all day events view

See Also:

CalendarDayViewItem.makeAllDayEventsView(Context)

setMaxColumns

public void setMaxColumns(int maxColumns)

Sets the maximum number of columns that will be used to layout the all day events. Default value is 2.

Parameters:

maxColumns - the max columns used by the all day events view

Throws:

IllegalArgumentException - when attempted to set a value less than 1

See Also:

CalendarDayViewItem.makeAllDayEventsView(Context)

getMaxVisibleEventRows

public float getMaxVisibleEventRows()

Gets a value that represents how many rows will be visible in the all day events view (given that there are enough events to fill these rows). For example if this value is `2.5` and there are 3 rows with events, there will be 2 and a half rows visible and the user will have to scroll in order to see the full third row.

Returns:

the max visible event rows in the all day events view

See Also:

CalendarDayViewItem.makeAllDayEventsView(Context)

setMaxVisibleEventRows

public void setMaxVisibleEventRows(float maxVisibleEventRows)

Sets a value that represents how many rows will be visible in the all day events view (given that there are enough events to fill these rows). For example if this value is `2.5` and there are 3 rows with events, there will be 2 and a half rows visible and the user will have to scroll in order to see the full third row.

Parameters:

maxVisibleEventRows - the max visible event rows in the all day events view

See Also:

CalendarDayViewItem.makeAllDayEventsView(Context)

getEventsSpacing

public int getEventsSpacing()

Gets a value in pixels that should be used between the all day events in the all day events view.

Returns:

the spacing between all day events views

See Also:

CalendarDayViewItem.makeAllDayEventsView(Context)

setEventsSpacing

public void setEventsSpacing(int eventsSpacing)

Sets a value in pixels that will be used between the all day events in the all day events view.

Parameters:

eventsSpacing - the spacing between all day events views

See Also:

CalendarDayViewItem.makeAllDayEventsView(Context)