org.sakaiproject.tool.calendar
Class CalendarAction.CustomizeCalendarPage

java.lang.Object
  extended byorg.sakaiproject.tool.calendar.CalendarAction.CustomizeCalendarPage
Enclosing class:
CalendarAction

public class CalendarAction.CustomizeCalendarPage
extends Object

This class controls the page that allows the user to add arbitrary attributes to the attribute list for the primary calendar that corresponds to the current group.


Constructor Summary
CalendarAction.CustomizeCalendarPage()
           
 
Method Summary
 void buildContext(VelocityPortlet portlet, Context context, RunData runData, CalendarActionState state, SessionState sstate)
          Build the context for addfields calendar (Options menu)
 void doAddfield(RunData runData, Context context, CalendarActionState state, SessionState sstate)
          Handles the click on the page to add a field to events that will be added to the calendar.
 void doCancel(RunData data, Context context, CalendarActionState state, SessionState sstate)
          Handles a click on the cancel button in the page that allows the user to add/remove events to/from events that will be added to the calendar.
 void doCustomize(RunData runData, Context context, CalendarActionState state, SessionState sstate)
          This initiates the page where the user can add/remove additional properties to/from events that will be added to the calendar.
 void doDeletefield(RunData runData, Context context, CalendarActionState state, SessionState sstate)
          Handles the click on the page to remove a field from events in the calendar.
 void doUpdate(RunData runData, Context context, CalendarActionState state, SessionState sstate)
          Handles the user clicking on the save button on the page to add or remove additional attributes for all calendar events.
 String getButtonHandlerID()
           
 String getButtonText()
           
 void loadAdditionalFieldsIntoContextFromCalendar(Calendar calendarObj, Context context)
          Loads additional fields information from the calendar object passed as a parameter and loads them into the context object for the Velocity template.
 void loadAdditionalFieldsMapFromRunData(RunData rundata, Map addfieldsMap, Calendar calendarObj)
          Loads additional fields from the run data into a provided map object.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

CalendarAction.CustomizeCalendarPage

public CalendarAction.CustomizeCalendarPage()
Method Detail

buildContext

public void buildContext(VelocityPortlet portlet,
                         Context context,
                         RunData runData,
                         CalendarActionState state,
                         SessionState sstate)
Build the context for addfields calendar (Options menu)


doAddfield

public void doAddfield(RunData runData,
                       Context context,
                       CalendarActionState state,
                       SessionState sstate)
Handles the click on the page to add a field to events that will be added to the calendar. Changes aren't complete until the user commits changes with a save.


doCancel

public void doCancel(RunData data,
                     Context context,
                     CalendarActionState state,
                     SessionState sstate)
Handles a click on the cancel button in the page that allows the user to add/remove events to/from events that will be added to the calendar.


doCustomize

public void doCustomize(RunData runData,
                        Context context,
                        CalendarActionState state,
                        SessionState sstate)
This initiates the page where the user can add/remove additional properties to/from events that will be added to the calendar.


doDeletefield

public void doDeletefield(RunData runData,
                          Context context,
                          CalendarActionState state,
                          SessionState sstate)
Handles the click on the page to remove a field from events in the calendar. Changes aren't complete until the user commits changes with a save.


doUpdate

public void doUpdate(RunData runData,
                     Context context,
                     CalendarActionState state,
                     SessionState sstate)
Handles the user clicking on the save button on the page to add or remove additional attributes for all calendar events.


getButtonHandlerID

public String getButtonHandlerID()

getButtonText

public String getButtonText()

loadAdditionalFieldsIntoContextFromCalendar

public void loadAdditionalFieldsIntoContextFromCalendar(Calendar calendarObj,
                                                        Context context)
Loads additional fields information from the calendar object passed as a parameter and loads them into the context object for the Velocity template.


loadAdditionalFieldsMapFromRunData

public void loadAdditionalFieldsMapFromRunData(RunData rundata,
                                               Map addfieldsMap,
                                               Calendar calendarObj)
Loads additional fields from the run data into a provided map object.