com.telerik.widget.calendar

Class CalendarScrollManager

java.lang.Object

com.telerik.widget.calendar.CalendarElement

com.telerik.widget.calendar.CalendarScrollManager

public class CalendarScrollManager
extends CalendarElement

This class is responsible for scrolling the calendar fragments and keeping track of their positions. It manages a set of three fragments and updates and rearranges them accordingly to the current scroll modes and direction so that it creates the illusion of endless fragments in both directions.

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
CalendarScrollManager(RadCalendarView owner) Creates a new instance of the CalendarScrollManager class.

Method Summary

Modifier and Type	Method and Description
void	arrange(int left, int top, int right, int bottom) Used to arrange the current element instance according to the given dimensions.
CalendarFragment	currentFragment() The current or center fragment.
int	currentSnapOffsetX() Calculates the current offset along the x axis that needs to be addressed so that the appropriate fragment according to the current scroll mode snaps to the screen.
int	currentSnapOffsetY() Calculates the current offset along the y axis that needs to be addressed so that the appropriate fragment according to the current scroll mode snaps to the screen.
long	getActiveDate() Gets the current active date.
CalendarCell	getCellForDate(long date) Returns an instance of the CalendarCell class representing the date cell for the provided Long date.
List<CalendarCell>	getCellsAtLocation(int x, int y) Returns a collection of cells that are located at a specific coordinates.
int	getMaxScrollOffset() Deprecated.
CalendarFragment	nextFragment() The fragment that comes after the current fragment.
void	onDateChanged() Used to update the manager after the display date of the owning calendar has been changed.
void	onSnapComplete() Handles the update of the fragments after snapping to the screen.
void	postRender(Canvas canvas) This method is called after calling the CalendarElement.render(android.graphics.Canvas) method.
CalendarFragment	previousFragment() The fragment that comes before the current 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	reset() Used to reset all the fragments of the manager.
void	reset(boolean force) Used to reset all the fragments of the manager in either forced or normal mode.
boolean	scroll(int offsetX, int offsetY) Scrolls the fragment with a specified offset according to the current position and the current scroll mode.
void	setActiveDate(long activeDate) Gets the current active date.
void	setMaxScrollOffset(int maxScrollOffset) Deprecated.
void	updateActiveFragment() Used to update the active state of the fragment.
void	updateDecorations()
void	updateEventsForFragments() Used to update the events of the calendar fragments.

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

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, setEnabled, setPadding, setPaddingHorizontal, setPaddingVertical, setParent, setVirtualOffsets, 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

CalendarScrollManager

public CalendarScrollManager(RadCalendarView owner)

Creates a new instance of the CalendarScrollManager class.

Parameters:

owner - the calendar view instance that owns this instance.

Method Detail

getMaxScrollOffset

public int getMaxScrollOffset()

Deprecated.

Gets the maximum scroll offset that will be applied for a given gesture. Deprecated - the scrolling offset will no longer be suppressed.

Returns:

the maximum scroll offset.

setMaxScrollOffset

public void setMaxScrollOffset(int maxScrollOffset)

Deprecated.

Sets the maximum scroll offset that will be applied for a given gesture. Deprecated - the scrolling offset will no longer be suppressed

Parameters:

maxScrollOffset - the new max scroll offset.

getActiveDate

public long getActiveDate()

Gets the current active date. This date might differ from the display date of the calendar during scroll.

Returns:

the current active date.

setActiveDate

public void setActiveDate(long activeDate)

Gets the current active date. This date might differ from the display date of the calendar during scroll. The active date will be updated after which a call to the updateActiveFragment() will be made, so that the change can be completed.

Parameters:

activeDate - the new active date.

currentFragment

public CalendarFragment currentFragment()

The current or center fragment.

Returns:

the current fragment.

nextFragment

public CalendarFragment nextFragment()

The fragment that comes after the current fragment.

Returns:

the next fragment.

previousFragment

public CalendarFragment previousFragment()

The fragment that comes before the current fragment.

Returns:

the previous fragment.

arrange

public void arrange(int left,
                    int top,
                    int right,
                    int bottom)

Description copied from class: CalendarElement

Used to arrange the current element instance according to the given dimensions.

Overrides:

arrange in class CalendarElement

Parameters:

left - the left border.

top - the top border.

right - the right border.

bottom - the bottom border.

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.

getCellsAtLocation

public List<CalendarCell> getCellsAtLocation(int x,
                                             int y)

Returns a collection of cells that are located at a specific coordinates. The reason it is a collection is because in some scroll modes there is overlapping of the fragments and there are invisible cells at the same location as visible ones.

Parameters:

x - the x coordinate.

y - the y coordinate.

Returns:

the collection of cells at this location.

scroll

public boolean scroll(int offsetX,
                      int offsetY)

Scrolls the fragment with a specified offset according to the current position and the current scroll mode.

Parameters:

offsetX - the offset along the x axis.

offsetY - the offset along the y axis.

Returns:

true if scroll was performed, false otherwise.

onDateChanged

public void onDateChanged()

Used to update the manager after the display date of the owning calendar has been changed.

currentSnapOffsetX

public int currentSnapOffsetX()

Calculates the current offset along the x axis that needs to be addressed so that the appropriate fragment according to the current scroll mode snaps to the screen.

Returns:

the current snap offset along the x axis.

currentSnapOffsetY

public int currentSnapOffsetY()

Calculates the current offset along the y axis that needs to be addressed so that the appropriate fragment according to the current scroll mode snaps to the screen.

Returns:

the current snap offset along the y axis.

reset

public void reset()

Used to reset all the fragments of the manager.

See Also:

CalendarFragment.reset()

reset

public void reset(boolean force)

Used to reset all the fragments of the manager in either forced or normal mode. Forced mode will cause the fragments to reinitialize to match a significant calendar change such as display mode change.

Parameters:

force - true if the reset should be forced, false otherwise.

See Also:

CalendarFragment.reset()

updateActiveFragment

public void updateActiveFragment()

Used to update the active state of the fragment.

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.

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.

onSnapComplete

public void onSnapComplete()

Handles the update of the fragments after snapping to the screen.

updateEventsForFragments

public void updateEventsForFragments()

Used to update the events of the calendar fragments. Scrolling will be disabled and the events for all cells will be updated. In case of attempting to scroll, the update will be canceled and the scrolling will be enabled.

updateDecorations

public void updateDecorations()