com.telerik.widget.calendar.dayview

Class DayEventsViewStyle

java.lang.Object

com.telerik.widget.calendar.dayview.DayEventsViewStyle

public class DayEventsViewStyle
extends Object

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

Constructor Summary

Constructors

Constructor and Description
DayEventsViewStyle(CalendarDayView owner) Constructor

Method Summary

Modifier and Type	Method and Description
int	getBackgroundColor() Gets the background color for day events view.
int	getBottomOffset() Gets a value in pixels representing the space after the last line that is drawn.
long	getEndTime() Gets a value in milliseconds representing the ending time of the visible area for events.
int	getEventsOffsetEnd() Gets a value in pixels representing the offset after the event views in DayEventsView.
int	getEventsOffsetStart() Gets a value in pixels representing the offset before the event views in DayEventsView and after the time labels.
int	getEventsSpacing() Gets a value in pixels that should be used between the events in the DayEventsView.
int	getMinEventHeight() Gets a value in pixels that defines what is the minimum height of an event.
long	getStartTime() Gets a value in milliseconds representing the starting time of the visible area for events.
int	getTimeLabelColor() Gets the text color of the time labels in DayEventsView.
SimpleDateFormat	getTimeLabelFormat() Gets the format for the time labels in DayEventsView.
int	getTimeLabelOffsetEnd() Gets a value in pixels representing the offset after the time labels in DayEventsView before the start of the area with lines and Views.
int	getTimeLabelOffsetStart() Gets a value in pixels representing the offset before the time labels in DayEventsView.
int	getTimeLabelTextSize() Gets a value in pixels representing the text size of the time labels in DayEventsView.
int	getTimeLinesColor() Gets the color used to draw the lines between the time intervals in DayEventsView.
long	getTimeLinesInterval() Gets a value in milliseconds representing the interval of time between two time lines in DayEventsView.
int	getTimeLinesOffsetEnd() Gets a value in pixels representing the offset after the time lines in DayEventsView.
int	getTimeLinesOffsetStart() Gets a value in pixels representing the offset before the time lines in DayEventsView and after the time labels.
int	getTimeLinesSpacing() Gets a value in pixels representing the interval of space between two time lines in DayEventsView.
boolean	getTimeLinesVisible() Gets a value indicating whether the time lines will be visible in DayEventsView.
int	getTimeLinesWidth() Gets a value in pixels representing the width of the time lines in DayEventsView.
int	getTopOffset() Gets a value in pixels representing the space before the first line that is drawn.
void	setBackgroundColor(int backgroundColor) Sets the background color for day events view.
void	setBottomOffset(int bottomOffset) Sets a value in pixels representing the space after the last line that is drawn.
void	setEndTime(long endTime) Sets a value in milliseconds representing the ending time of the visible area for events.
void	setEventsOffsetEnd(int eventsOffsetEnd) Sets a value in pixels representing the offset after the event views in DayEventsView.
void	setEventsOffsetStart(int eventsOffsetStart) Sets a value in pixels representing the offset before the event views in DayEventsView and after the time labels.
void	setEventsSpacing(int eventsSpacing) Sets a value in pixels that will be used between the all day events in the DayEventsView.
void	setMinEventHeight(int minEventHeight) Sets a value in pixels that defines what is the minimum height of an event.
void	setStartTime(long startTime) Sets a value in milliseconds representing the starting time of the visible area for events.
void	setTimeLabelColor(int timeLabelColor) Sets the text color of the time labels in DayEventsView.
void	setTimeLabelFormat(SimpleDateFormat timeLabelFormat) Sets a format for the time labels in DayEventsView.
void	setTimeLabelOffsetEnd(int timeLabelOffsetEnd) Sets a value in pixels representing the offset after the time labels in DayEventsView before the start of the area with lines and Views.
void	setTimeLabelOffsetStart(int timeLabelOffsetStart) Sets a value in pixels representing the offset before the time labels in DayEventsView.
void	setTimeLabelTextSize(int timeLabelTextSize) Sets a value in pixels representing the text size of the time labels in DayEventsView.
void	setTimeLinesColor(int timeLinesColor) Sets the color used to draw the lines between the time intervals in DayEventsView.
void	setTimeLinesInterval(long timeLinesInterval) Sets a value in milliseconds representing the interval of time between two time lines in DayEventsView.
void	setTimeLinesOffsetEnd(int timeLinesOffsetEnd) Sets a value in pixels representing the offset after the time lines in DayEventsView.
void	setTimeLinesOffsetStart(int timeLinesOffsetStart) Sets a value in pixels representing the offset before the time lines in DayEventsView and after the time labels.
void	setTimeLinesSpacing(int timeLinesSpacing) Sets a value in pixels representing the interval of space between two time lines in DayEventsView.
void	setTimeLinesVisible(boolean timeLinesVisible) Sets a value indicating whether the time lines should be visible in DayEventsView.
void	setTimeLinesWidth(int timeLinesWidth) Sets a value in pixels representing the width of the time lines in DayEventsView.
void	setTopOffset(int topOffset) Sets a value in pixels representing the space before the first line that is drawn.

Methods inherited from class java.lang.Object

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

Constructor Detail

DayEventsViewStyle

public DayEventsViewStyle(CalendarDayView owner)

Constructor

Parameters:

owner - the dayView that will use this style

Method Detail

getBackgroundColor

public int getBackgroundColor()

Gets the background color for day events view.

Returns:

the current day views container background color

See Also:

CalendarDayViewItem.makeDayEventsView(Context)

setBackgroundColor

public void setBackgroundColor(int backgroundColor)

Sets the background color for day events view.

Parameters:

backgroundColor - the day views container background color

See Also:

CalendarDayViewItem.makeDayEventsView(Context)

getTimeLinesInterval

public long getTimeLinesInterval()

Gets a value in milliseconds representing the interval of time between two time lines in DayEventsView. Default value is the amount of milliseconds in one hour (60 * 60 * 1000).

Returns:

the current interval between time lines

See Also:

CalendarDayViewItem.makeDayEventsView(Context)

setTimeLinesInterval

public void setTimeLinesInterval(long timeLinesInterval)

Sets a value in milliseconds representing the interval of time between two time lines in DayEventsView. Default value is the amount of milliseconds in one hour (60 * 60 * 1000).

Parameters:

timeLinesInterval - the new interval between time lines

See Also:

CalendarDayViewItem.makeDayEventsView(Context)

getTimeLinesSpacing

public int getTimeLinesSpacing()

Gets a value in pixels representing the interval of space between two time lines in DayEventsView. Default value is converted from dips depending on the current device's density.

Returns:

the current distance between time lines

See Also:

CalendarDayViewItem.makeDayEventsView(Context)

setTimeLinesSpacing

public void setTimeLinesSpacing(int timeLinesSpacing)

Sets a value in pixels representing the interval of space between two time lines in DayEventsView. Default value is converted from dips depending on the current device's density.

Parameters:

timeLinesSpacing - the new distance between time lines

See Also:

CalendarDayViewItem.makeDayEventsView(Context)

getStartTime

public long getStartTime()

Gets a value in milliseconds representing the starting time of the visible area for events. Default value is `0`.

Returns:

the start time for visible events

See Also:

CalendarDayViewItem.makeDayEventsView(Context)

setStartTime

public void setStartTime(long startTime)

Sets a value in milliseconds representing the starting time of the visible area for events. Default value is `0`.

Parameters:

startTime - the new start time for visible events

Throws:

IllegalArgumentException - if the value of start time is less than 0 or if it is more than the value of endTime

See Also:

CalendarDayViewItem.makeDayEventsView(Context)

getEndTime

public long getEndTime()

Gets a value in milliseconds representing the ending time of the visible area for events. Default value is the count of milliseconds in 24 hours (24 * 60 * 60 * 1000).

Returns:

the end time for visible events

See Also:

CalendarDayViewItem.makeDayEventsView(Context)

setEndTime

public void setEndTime(long endTime)

Sets a value in milliseconds representing the ending time of the visible area for events. Default value is the count of milliseconds in 24 hours (24 * 60 * 60 * 1000). The value of end time can't exceed the count of milliseconds in 24 hours.

Parameters:

endTime - the new end time for visible events

Throws:

IllegalArgumentException - if the value of end time exceeds the milliseconds in 24 hours or if it is less than the value of startTime

See Also:

CalendarDayViewItem.makeDayEventsView(Context)

getTopOffset

public int getTopOffset()

Gets a value in pixels representing the space before the first line that is drawn. Please note that if this value is 0 or less the first line will not be drawn.

Returns:

the top offset

See Also:

CalendarDayViewItem.makeDayEventsView(Context)

setTopOffset

public void setTopOffset(int topOffset)

Sets a value in pixels representing the space before the first line that is drawn. Please note that if this value is 0 or less the first line will not be drawn.

Parameters:

topOffset - the new top offset

See Also:

CalendarDayViewItem.makeDayEventsView(Context)

getBottomOffset

public int getBottomOffset()

Gets a value in pixels representing the space after the last line that is drawn. Please note that if this value is 0 or less the last line will not be drawn.

Returns:

the bottom offset

See Also:

CalendarDayViewItem.makeDayEventsView(Context)

setBottomOffset

public void setBottomOffset(int bottomOffset)

Sets a value in pixels representing the space after the last line that is drawn. Please note that if this value is 0 or less the last line will not be drawn.

Parameters:

bottomOffset - the new bottom offset

See Also:

CalendarDayViewItem.makeDayEventsView(Context)

getTimeLabelTextSize

public int getTimeLabelTextSize()

Gets a value in pixels representing the text size of the time labels in DayEventsView. Default value is converted from dips depending on the current device's density.

Returns:

the current text size of the time labels

See Also:

CalendarDayViewItem.makeDayEventsView(Context)

setTimeLabelTextSize

public void setTimeLabelTextSize(int timeLabelTextSize)

Sets a value in pixels representing the text size of the time labels in DayEventsView. Default value is converted from dips depending on the current device's density.

Parameters:

timeLabelTextSize - the new text size of the time labels

See Also:

CalendarDayViewItem.makeDayEventsView(Context)

getTimeLabelColor

public int getTimeLabelColor()

Gets the text color of the time labels in DayEventsView.

Returns:

the current text color of the time labels

See Also:

CalendarDayViewItem.makeDayEventsView(Context)

setTimeLabelColor

public void setTimeLabelColor(int timeLabelColor)

Sets the text color of the time labels in DayEventsView.

Parameters:

timeLabelColor - the new text color of the time labels

See Also:

CalendarDayViewItem.makeDayEventsView(Context)

getTimeLabelOffsetEnd

public int getTimeLabelOffsetEnd()

Gets a value in pixels representing the offset after the time labels in DayEventsView before the start of the area with lines and Views. Default value is converted from dips depending on the current device's density.

Returns:

the current offset after the time labels

See Also:

CalendarDayViewItem.makeDayEventsView(Context)

setTimeLabelOffsetEnd

public void setTimeLabelOffsetEnd(int timeLabelOffsetEnd)

Sets a value in pixels representing the offset after the time labels in DayEventsView before the start of the area with lines and Views. Default value is converted from dips depending on the current device's density.

Parameters:

timeLabelOffsetEnd - the new offset after the time labels

See Also:

CalendarDayViewItem.makeDayEventsView(Context)

getTimeLabelOffsetStart

public int getTimeLabelOffsetStart()

Gets a value in pixels representing the offset before the time labels in DayEventsView. Default value is converted from dips depending on the current device's density.

Returns:

the current offset before the time labels

See Also:

CalendarDayViewItem.makeDayEventsView(Context)

setTimeLabelOffsetStart

public void setTimeLabelOffsetStart(int timeLabelOffsetStart)

Sets a value in pixels representing the offset before the time labels in DayEventsView. Default value is converted from dips depending on the current device's density.

Parameters:

timeLabelOffsetStart - the new offset before the time labels

See Also:

CalendarDayViewItem.makeDayEventsView(Context)

getTimeLabelFormat

public SimpleDateFormat getTimeLabelFormat()

Gets the format for the time labels in DayEventsView. Default value is created from the following format string: "h a" and the current locale of the calendar.

Returns:

the current time labels format

See Also:

CalendarDayViewItem.makeDayEventsView(Context)

setTimeLabelFormat

public void setTimeLabelFormat(SimpleDateFormat timeLabelFormat)

Sets a format for the time labels in DayEventsView. Default value is created from the following format string: "h a" and the current locale of the calendar.

Parameters:

timeLabelFormat - the new time labels format

See Also:

CalendarDayViewItem.makeDayEventsView(Context)

getTimeLinesColor

public int getTimeLinesColor()

Gets the color used to draw the lines between the time intervals in DayEventsView.

Returns:

the current time lines color

See Also:

CalendarDayViewItem.makeDayEventsView(Context)

setTimeLinesColor

public void setTimeLinesColor(int timeLinesColor)

Sets the color used to draw the lines between the time intervals in DayEventsView.

Parameters:

timeLinesColor - the new time lines color

See Also:

CalendarDayViewItem.makeDayEventsView(Context)

getTimeLinesWidth

public int getTimeLinesWidth()

Gets a value in pixels representing the width of the time lines in DayEventsView. Default value is `0` which draws lines in hairline mode. Hairlines always draws a single pixel independent of the canvas' matrix.

Returns:

the current width of the time lines

See Also:

CalendarDayViewItem.makeDayEventsView(Context)

setTimeLinesWidth

public void setTimeLinesWidth(int timeLinesWidth)

Sets a value in pixels representing the width of the time lines in DayEventsView. Default value is `0` which draws lines in hairline mode. Hairlines always draws a single pixel independent of the canvas' matrix.

Parameters:

timeLinesWidth - the new width of the time lines

See Also:

CalendarDayViewItem.makeDayEventsView(Context)

getTimeLinesOffsetEnd

public int getTimeLinesOffsetEnd()

Gets a value in pixels representing the offset after the time lines in DayEventsView. Default value is converted from dips depending on the current device's density.

Returns:

the current offset after the time lines

See Also:

CalendarDayViewItem.makeDayEventsView(Context)

setTimeLinesOffsetEnd

public void setTimeLinesOffsetEnd(int timeLinesOffsetEnd)

Sets a value in pixels representing the offset after the time lines in DayEventsView. Default value is converted from dips depending on the current device's density.

Parameters:

timeLinesOffsetEnd - the new offset after the time lines

See Also:

CalendarDayViewItem.makeDayEventsView(Context)

getTimeLinesOffsetStart

public int getTimeLinesOffsetStart()

Gets a value in pixels representing the offset before the time lines in DayEventsView and after the time labels. Default value is converted from dips depending on the current device's density.

Returns:

the current offset before the time lines

See Also:

CalendarDayViewItem.makeDayEventsView(Context)

setTimeLinesOffsetStart

public void setTimeLinesOffsetStart(int timeLinesOffsetStart)

Sets a value in pixels representing the offset before the time lines in DayEventsView and after the time labels. Default value is converted from dips depending on the current device's density.

Parameters:

timeLinesOffsetStart - the new offset before the time lines

See Also:

CalendarDayViewItem.makeDayEventsView(Context)

getTimeLinesVisible

public boolean getTimeLinesVisible()

Gets a value indicating whether the time lines will be visible in DayEventsView. Default value is `true`.

Returns:

whether time lines are currently visible

See Also:

CalendarDayViewItem.makeDayEventsView(Context)

setTimeLinesVisible

public void setTimeLinesVisible(boolean timeLinesVisible)

Sets a value indicating whether the time lines should be visible in DayEventsView. Default value is `true`.

Parameters:

timeLinesVisible - whether time lines are currently visible

See Also:

CalendarDayViewItem.makeDayEventsView(Context)

getEventsOffsetStart

public int getEventsOffsetStart()

Gets a value in pixels representing the offset before the event views in DayEventsView and after the time labels. Default value is converted from dips depending on the current device's density.

Returns:

the current offset before the event views

See Also:

CalendarDayViewItem.makeDayEventsView(Context)

setEventsOffsetStart

public void setEventsOffsetStart(int eventsOffsetStart)

Sets a value in pixels representing the offset before the event views in DayEventsView and after the time labels. Default value is converted from dips depending on the current device's density.

Parameters:

eventsOffsetStart - the new offset before the event views

See Also:

CalendarDayViewItem.makeDayEventsView(Context)

getEventsOffsetEnd

public int getEventsOffsetEnd()

Gets a value in pixels representing the offset after the event views in DayEventsView. Default value is converted from dips depending on the current device's density.

Returns:

the current offset after the event views

See Also:

CalendarDayViewItem.makeDayEventsView(Context)

setEventsOffsetEnd

public void setEventsOffsetEnd(int eventsOffsetEnd)

Sets a value in pixels representing the offset after the event views in DayEventsView. Default value is converted from dips depending on the current device's density.

Parameters:

eventsOffsetEnd - the new offset after the event views

See Also:

CalendarDayViewItem.makeDayEventsView(Context)

getEventsSpacing

public int getEventsSpacing()

Gets a value in pixels that should be used between the events in the DayEventsView.

Returns:

the spacing between the day events views

See Also:

CalendarDayViewItem.makeDayEventsView(Context)

setEventsSpacing

public void setEventsSpacing(int eventsSpacing)

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

Parameters:

eventsSpacing - the spacing between day events views

See Also:

CalendarDayViewItem.makeDayEventsView(Context)

getMinEventHeight

public int getMinEventHeight()

Gets a value in pixels that defines what is the minimum height of an event. This property is used to ensure that even very short events (for example 1 minute long) are visible.

Returns:

the minimum height of an event

See Also:

CalendarDayViewItem.makeDayEventsView(Context)

setMinEventHeight

public void setMinEventHeight(int minEventHeight)

Sets a value in pixels that defines what is the minimum height of an event. This property is used to ensure that even very short events (for example 1 minute long) are visible.

Parameters:

minEventHeight - the minimum height of an event

See Also:

CalendarDayViewItem.makeDayEventsView(Context)