fr.paris.lutece.plugins.calendar.web
Interface CalendarView

All Known Implementing Classes:
DayCalendarView, MonthCalendarView, WeekCalendarView

public interface CalendarView

This interface describes the minimum implementation for a Calendar View


Field Summary
static int TYPE_DAY
           
static int TYPE_MONTH
           
static int TYPE_WEEK
           
 
Method Summary
 java.lang.String getCalendarView(java.lang.String strDate, MultiAgenda agenda, CalendarUserOptions options)
          Returns the HTML view of the Month corresponding to the given date and displaying events of a given agenda
 java.lang.String getNext(java.lang.String strDate)
          Returns the next code date corresponding to the current view and the current date
 java.lang.String getPath(java.lang.String strDate, CalendarUserOptions options)
          Returns the view path
 java.lang.String getPrevious(java.lang.String strDate)
          Returns the previous code date corresponding to the current view and the current date
 java.lang.String getTitle(java.lang.String strDate, CalendarUserOptions options)
          Returns the view title
 int getType()
          Returns the view type
 

Field Detail

TYPE_DAY

static final int TYPE_DAY
See Also:
Constant Field Values

TYPE_WEEK

static final int TYPE_WEEK
See Also:
Constant Field Values

TYPE_MONTH

static final int TYPE_MONTH
See Also:
Constant Field Values
Method Detail

getCalendarView

java.lang.String getCalendarView(java.lang.String strDate,
                                 MultiAgenda agenda,
                                 CalendarUserOptions options)
Returns the HTML view of the Month corresponding to the given date and displaying events of a given agenda

Parameters:
strDate - The date code
agenda - An agenda
Returns:
The view in HTML

getNext

java.lang.String getNext(java.lang.String strDate)
Returns the next code date corresponding to the current view and the current date

Parameters:
strDate - The current date code
Returns:
The next code date

getPrevious

java.lang.String getPrevious(java.lang.String strDate)
Returns the previous code date corresponding to the current view and the current date

Parameters:
strDate - The current date code
Returns:
The previous code date

getTitle

java.lang.String getTitle(java.lang.String strDate,
                          CalendarUserOptions options)
Returns the view title

Parameters:
strDate - The current date code
Returns:
The view title

getPath

java.lang.String getPath(java.lang.String strDate,
                         CalendarUserOptions options)
Returns the view path

Parameters:
strDate - The current date code
Returns:
The view path

getType

int getType()
Returns the view type

Returns:
The view type


Copyright © 2007 Mairie de Paris. All Rights Reserved.