com.telerik.widget.calendar

Class CalendarFragment

java.lang.Object

com.telerik.widget.calendar.CalendarElement

com.telerik.widget.calendar.CalendarFragment

public class CalendarFragment
extends CalendarElement

The calendar fragment is a class holding a single "page" of the calendar. It operates according to the current CalendarDisplayMode and can be of the shape of a rectangle or jagged if trimmed (vertical month mode).

Field Summary

Fields inherited from class com.telerik.widget.calendar.CalendarElement

BOTTOM, CENTER, CENTER_HORIZONTAL, CENTER_VERTICAL, LEFT, RIGHT, TOP

Constructor Summary

Constructors

Constructor and Description
CalendarFragment(RadCalendarView owner) Creates a new instance of the CalendarFragment class.

Method Summary

Modifier and Type	Method and Description
int	firstFullRowIndex() Gets the index of the first row, that holds only cells, which date is from the same range like the current display date for the fragment.
CalendarCell	getCellAtLocation(int x, int y) Gets a cell at certain location having in mind the virtual position of the fragment.
CalendarCell	getCellForDate(long date) Returns an instance of the CalendarCell class representing the date cell for the provided Long date.
long	getDisplayDate() Gets the current display date that is represented by this fragment instance.
CalendarDisplayMode	getDisplayMode() Gets the current display mode.
int	getVirtualXPosition() Deprecated.
int	getVirtualYPosition() Deprecated.
boolean	isCurrentFragment() Gets a value that determines whether this is the current fragment or not.
int	lastRowWithCurrentDateCellsIndex() Gets the index of the last row, that has at least one cell from the same range like the current display date for the fragment.
void	postRender(Canvas canvas) This method is called after calling the CalendarElement.render(android.graphics.Canvas) method.
void	postRender(Canvas canvas, boolean drawDecorations) Extends the post render logic by adding the option to draw the decorations.
void	recycle() Clears all content from the fragment.
void	render(Canvas canvas) This method is called at onDraw() call from the main calendar view instance and is used for drawing all custom elements building the calendar structure.
void	render(Canvas canvas, boolean drawDecorations) Extends the render logic, adds the option to state specifically whether the decorations should be drawn during the render phase, or later in the postRender phase.
void	reset() Resets the current fragment instance.
void	reset(CalendarDisplayMode forDisplayMode) Resets the current fragment by rebuilding its structure based on the provided display mode.
double	rowHeight() Gets the getHeight of a single row contained inside the fragment, where all rows have the same getHeight at all times.
ArrayList<CalendarRow>	rows() The collection holding the rows for the current fragment instance.
void	setCurrentFragment(boolean currentFragment) Sets a value that determines whether this is the current fragment or not.
void	setDisplayDate(long displayDate) Sets the current display date that is represented by this fragment instance.
void	setDisplayMode(CalendarDisplayMode displayMode) Sets the current display mode.
void	setEnabled(boolean enabled) Sets a value determining whether the current element is enabled.
void	setVirtualOffsets(int offsetX, int offsetY) Sets the virtual offsets of the element along the x and y axes.
void	setVirtualXPosition(int virtualXPosition) Deprecated.
void	setVirtualYPosition(int virtualYPosition) Deprecated.
void	trim() Used to trim the cells before and after the ones that are in the same range as the current display date of the fragment.
void	updateDecorations() Used to update the decorations for the cells of the current fragment instance, so that they are ready for rendering.

Methods inherited from class com.telerik.widget.calendar.CalendarElement

arrange, calcBorderRect, getAlpha, getBackgroundColorDisabled, getBackgroundColorEnabled, getBitmap, getBitmapPosition, getBottom, getHeight, getLeft, getPaddingBottom, getPaddingLeft, getPaddingRight, getPaddingTop, getParent, getRight, getTop, getVirtualOffsetX, getVirtualOffsetY, getVisibility, getWidth, isEnabled, pointIsInsideElement, setAlpha, setBackgroundColor, setBackgroundColorDisabled, setBackgroundColorEnabled, setBitmap, setBitmapPosition, setPadding, setPaddingHorizontal, setPaddingVertical, setParent, setVirtualOffsetX, setVirtualOffsetY, setVisibility, translate, virtualBottom, virtualLeft, virtualRight, virtualTop, virtualTranslate

Methods inherited from class java.lang.Object

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

Constructor Detail

CalendarFragment

public CalendarFragment(RadCalendarView owner)

Creates a new instance of the CalendarFragment class.

Parameters:

owner - the current calendar view instance that owns the fragment.

Method Detail

isCurrentFragment

public boolean isCurrentFragment()

Gets a value that determines whether this is the current fragment or not.

Returns:

true if this is the current fragment, false otherwise.

setCurrentFragment

public void setCurrentFragment(boolean currentFragment)

Sets a value that determines whether this is the current fragment or not.

Parameters:

currentFragment - the new current state.

getDisplayMode

public CalendarDisplayMode getDisplayMode()

Gets the current display mode.

Returns:

the current display mode.

setDisplayMode

public void setDisplayMode(CalendarDisplayMode displayMode)

Sets the current display mode.

Parameters:

displayMode - the new display mode.

getVirtualXPosition

public int getVirtualXPosition()

Deprecated.

Gets the virtual position of the fragment along the x axis. This position is used to translate the canvas at render time, so that the elements of the fragment are not being translated at every frame, but rather this process is virtualized for better performance.

Returns:

the current virtual x position.

setVirtualXPosition

public void setVirtualXPosition(int virtualXPosition)

Deprecated.

Sets the virtual position of the fragment along the x axis. This position is used to translate the canvas at render time, so that the elements of the fragment are not being translated at every frame, but rather this process is virtualized for better performance.

Parameters:

virtualXPosition - the new virtual x position.

getVirtualYPosition

public int getVirtualYPosition()

Deprecated.

Gets the virtual position of the fragment along the y axis. This position is used to translate the canvas at render time, so that the elements of the fragment are not being translated at every frame, but rather this process is virtualized for better performance.

Returns:

the current virtual y position.

setVirtualYPosition

public void setVirtualYPosition(int virtualYPosition)

Deprecated.

Sets the virtual position of the fragment along the y axis. This position is used to translate the canvas at render time, so that the elements of the fragment are not being translated at every frame, but rather this process is virtualized for better performance.

Parameters:

virtualYPosition - the new virtual y position.

getDisplayDate

public long getDisplayDate()

Gets the current display date that is represented by this fragment instance.

Returns:

the current display date.

setDisplayDate

public void setDisplayDate(long displayDate)

Sets the current display date that is represented by this fragment instance.

Parameters:

displayDate - the new display date.

firstFullRowIndex

public int firstFullRowIndex()

Gets the index of the first row, that holds only cells, which date is from the same range like the current display date for the fragment. It is updated every time that trim() is being invoked.

Returns:

the current first full row index.

lastRowWithCurrentDateCellsIndex

public int lastRowWithCurrentDateCellsIndex()

Gets the index of the last row, that has at least one cell from the same range like the current display date for the fragment. It is updated every time that trim() has been invoked.

Returns:

the current last

setEnabled

public void setEnabled(boolean enabled)

Description copied from class: CalendarElement

Sets a value determining whether the current element is enabled.

Overrides:

setEnabled in class CalendarElement

Parameters:

enabled - the new enabled state.

rowHeight

public double rowHeight()

Gets the getHeight of a single row contained inside the fragment, where all rows have the same getHeight at all times.

Returns:

the current getHeight of a single row contained inside the fragment instance.

rows

public ArrayList<CalendarRow> rows()

The collection holding the rows for the current fragment instance.

Returns:

the current collection of rows.

render

public void render(Canvas canvas)

Description copied from class: CalendarElement

This method is called at onDraw() call from the main calendar view instance and is used for drawing all custom elements building the calendar structure.

Overrides:

render in class CalendarElement

Parameters:

canvas - the canvas of the main calendar view instance.

render

public void render(Canvas canvas,
                   boolean drawDecorations)

Extends the render logic, adds the option to state specifically whether the decorations should be drawn during the render phase, or later in the postRender phase. Used for overlapping modes such as Overlap and Stack.

Parameters:

canvas - the current canvas.

drawDecorations - true will result in drawing the decorations in the render phase, false will halt the operation, so that post render can handle it.

postRender

public void postRender(Canvas canvas)

Description copied from class: CalendarElement

This method is called after calling the CalendarElement.render(android.graphics.Canvas) method.

Overrides:

postRender in class CalendarElement

Parameters:

canvas - the canvas of the main calendar view instance.

setVirtualOffsets

public void setVirtualOffsets(int offsetX,
                              int offsetY)

Description copied from class: CalendarElement

Sets the virtual offsets of the element along the x and y axes. Used when scrolling for better performance.

Overrides:

setVirtualOffsets in class CalendarElement

Parameters:

offsetX - the new virtual offset along the x axis.

offsetY - the new virtual offset along the y axis.

postRender

public void postRender(Canvas canvas,
                       boolean drawDecorations)

Extends the post render logic by adding the option to draw the decorations.

Parameters:

canvas - the current canvas.

drawDecorations - true will result in drawing the decorations, false will halt the operation.

trim

public void trim()

Used to trim the cells before and after the ones that are in the same range as the current display date of the fragment. These cells' visibility level will be set to Invisible.

reset

public void reset()

Resets the current fragment instance. Used when switching between different display modes. It will use the current display mode of the current calendar view instance.

reset

public void reset(CalendarDisplayMode forDisplayMode)

Resets the current fragment by rebuilding its structure based on the provided display mode.

Parameters:

forDisplayMode - the CalendarDisplayMode value to rebuild for.

getCellAtLocation

public CalendarCell getCellAtLocation(int x,
                                      int y)

Gets a cell at certain location having in mind the virtual position of the fragment.

Parameters:

x - the x position of the cell before switching to virtual coordinates.

y - the y position of the cell before switching to virtual coordinates.

Returns:

the cell that is located at the given coordinates or null if no cell is found.

getCellForDate

public CalendarCell getCellForDate(long date)

Returns an instance of the CalendarCell class representing the date cell for the provided Long date.

Parameters:

date - the date to return the cell for.

Returns:

the CalendarCell displaying the provided date.

updateDecorations

public void updateDecorations()

Used to update the decorations for the cells of the current fragment instance, so that they are ready for rendering.

recycle

public void recycle()

Clears all content from the fragment.