com.jalios.jcms.calendar
Class PortletCalendarHandler

java.lang.Object
  com.jalios.jcms.context.JcmsContext
      com.jalios.jcms.context.JcmsJspContext
          com.jalios.jcms.handler.JcmsFormHandler
              com.jalios.jcms.calendar.PortletCalendarHandler

All Implemented Interfaces:

JcmsConstants, JaliosConstants

public class PortletCalendarHandler
extends JcmsFormHandler

Since:

jcms-5.0.0

Version:

$Revision: 23104 $

Author:

Olivier Jaquemet

Nested Class Summary

static class

PortletCalendarHandler.CalendarDay class returned during enumeration of a calendar handler

Field Summary

static String

REVISION

Fields inherited from class com.jalios.jcms.handler.JcmsFormHandler

contextMap, editFieldSet, noRedirect, noSendRedirect, popupEdition, redirect, redirectOnClosePopup, workspaceForced

Fields inherited from class com.jalios.jcms.context.JcmsJspContext

AJAX_REQUEST_ATTRIBUTES, BODY_HEADER, CSS_HEADER, cssboMap, cssfoMap, CUSTOM_HEADER, editIcon, HTTPEQUIV_HEADER, httpequivMap, HTTPNAME_HEADER, httpnameMap, initEditIcon, JAVASCRIPT_CODE_SET_ATTRIBUTE, JAVASCRIPT_SET_ATTRIBUTE, JS_HEADER, jsboMap, jsboSet, jsfoMap, jsfoSet, out, pageContext, SHOW_EDIT_ICON, STYLE_HEADER

Fields inherited from class com.jalios.jcms.context.JcmsContext

browser, caddy, channel, inFO, initDone, initWorkspace, isAdmin, isAjaxRequest, isDBMember, isDebug, isLogged, loggedMember, request, response, userLang, userLocale, workspace

Fields inherited from interface com.jalios.jcms.JcmsConstants

ADATE_SEARCH, ADMIN_NOTES_PROP, ADVANCED_TAB, ARCHIVES_DIR, ASCII_WIDTH, CATEGORY_TAB, CDATE_SEARCH, COMMON_ALARM, CONTENT_TAB, COOKIE_MAX_AGE, CRYPT_MD5, CRYPT_UNDEFINED, CRYPT_UNIX, CTRL_TOPIC_INTERNAL, CTRL_TOPIC_REF, CTRL_TOPIC_VALUE, CTRL_TOPIC_WRITE, CUSTOM_PROP, DOCCHOOSER_HEIGHT, DOCCHOOSER_WIDTH, DOCS_DIR, EDATE_SEARCH, EMAIL_REGEXP, ERROR_MSG, FORBIDDEN_FILE_ACCESS, FORBIDDEN_REDIRECT, FORCE_REDIRECT, ICON_ARCHIVE, ICON_LOCK, ICON_LOCK_STRONG, ICON_WARN, ICON_WH_BOOK_CLOSED, ICON_WH_BOOK_OPEN, INFORMATION_MSG, JALIOS_JUNIT_PROP, JCMS_CADDY, JSYNC_DOWNLOAD_DIR, JSYNC_SYNC_ALARM, LOG_FILE, LOG_TOPIC_SECURITY, LOGGER_PROP, LOGGER_XMLPROP, MBR_PHOTO_DIR, MDATE_SEARCH, MONITOR_XML, OP_CREATE, OP_DEEP_COPY, OP_DEEP_DELETE, OP_DELETE, OP_MERGE, OP_UPDATE, PDATE_SEARCH, PHOTO_LARGE, PHOTO_LARGE_HEIGHT, PHOTO_LARGE_WIDTH, PHOTO_NORMAL, PHOTO_NORMAL_HEIGHT, PHOTO_NORMAL_WIDTH, PHOTO_SMALL, PHOTO_SMALL_HEIGHT, PHOTO_SMALL_WIDTH, PHOTO_TINY, PHOTO_TINY_HEIGHT, PHOTO_TINY_WIDTH, PREVIOUS_TAB, PRINT_VIEW, PRIVATE_FILE_ACCESS, PUBLIC_FILE_ACCESS, READ_RIGHT_TAB, SDATE_SEARCH, SEARCHENGINE_ALARM, SESSION_AUTHORIZED_FILENAMES_SET, STATS_REPORT_DIR, STATUS_PROP, STORE_XML, TEMPLATE_TAB, THUMBNAIL_LARGE_HEIGHT, THUMBNAIL_LARGE_WIDTH, THUMBNAIL_SMALL_HEIGHT, THUMBNAIL_SMALL_WIDTH, UDATE_SEARCH, UPDATE_RIGHT_TAB, UPLOAD_DIR, URL_REGEXP, WARNING_MSG, WEBAPP_PROP, WFEXPRESS_ALARM, WFREMINDER_ALARM, WORKFLOW_TAB, WORKFLOW_XML

Fields inherited from interface com.jalios.util.JaliosConstants

CRLF, MILLIS_IN_ONE_DAY, MILLIS_IN_ONE_HOUR, MILLIS_IN_ONE_MINUTE, MILLIS_IN_ONE_MONTH, MILLIS_IN_ONE_SECOND, MILLIS_IN_ONE_WEEK, MILLIS_IN_ONE_YEAR

Constructor Summary

PortletCalendarHandler()

Method Summary

Enumeration	elements()
long	getCalDate() get / set start date as long
int	getCalDayNbr() get / set number of day to display in days mode
String	getCalMode() get / set calendar mode as string
String	getDayUrl()
String	getDayUrl(PortalElement portlet, Date date, boolean inPortlet)
int	getDefaultDayDuration()
int	getDefaultDayStartHour()
Date	getEndDate()
String	getHeader()
Calendar	getMonthCal()
String	getMonthUrl()
String	getMonthUrl(PortalElement portlet, Date date, boolean inPortlet)
String	getNDaysAfterUrl()
String	getNDaysBeforeUrl()
String	getNext6HourUrl()
String	getNextDayUrl()
String	getNextHourUrl()
String	getNextMonthUrl()
String	getNextWeekUrl()
static String	getPortletCalendarEventDisplayURL(javax.servlet.http.HttpServletRequest request, PortalElement portlet, AbstractCalendarEvent calEv, String view)
String	getPrevious6HourUrl()
String	getPreviousDayUrl()
String	getPreviousHourUrl()
String	getPreviousMonthUrl()
String	getPreviousWeekUrl()
Date	getStartDate()
String	getTodayUrl()
String	getWeekUrl()
String	getWorkWeekUrl()
void	init(PortalElement portlet)
boolean	isDaysMode()
boolean	isMonthMode()
void	setCalDate(long dateL)
void	setCalDayNbr(int value)
void	setCalMode(String modeStr)
void	setDefaultDayDuration(int dayDuration)
void	setDefaultDayStartHour(int startHour)
void	setDefaultModeFromView(String str) Set defaults value given by portlet calendar

Methods inherited from class com.jalios.jcms.handler.JcmsFormHandler

getControllerContext, getEditFieldSet, getMainLangValue, getMainLangValueArray, getMLMap, getMLMapArray, getRedirect, getRedirectOnClosePopup, getWorkspace, isFieldEdition, isFieldMissing, isPartialFieldEdition, isPopupEdition, isWorkspaceForced, processStatus, sendRedirect, sendRedirect, setEditField, setNoRedirect, setNoSendRedirect, setPopupEdition, setRedirect, setRedirectOnClosePopup, setWorkspace, setWs, updateUploadedField, updateUploadedFields

Methods inherited from class com.jalios.jcms.context.JcmsJspContext

addBodyAttributes, addCSSHeader, addCSSHeader, addCSSHeader, addCSSHeader, addCustomHeader, addHttpEquivHeader, addHttpNameHeader, addJavaScript, addJavaScript, addJavaScript, addJavaScriptCode, addJSHeader, addJSHeader, addJSHeader, addJSHeader, addStyleHeader, addStyleHeader, debugDisplayContext, forceEditIcon, forceUpdate, getAjaxRequestAttribute, getAjaxRequestId, getAllHeadersDiffMap, getAllHeadersMap, getBackOfficeCSSHeader, getBackOfficeJavaScriptSet, getBackOfficeJSHeader, getBodyAttributes, getContentForm, getCSSHeaders, getCtxCategories, getCurrentCategory, getCustomHeaders, getDocType, getFinalCSSMap, getFinalJavaScriptSet, getFormElementCount, getFrontOfficeCSSHeader, getFrontOfficeJavaScriptSet, getFrontOfficeJSHeader, getHttpEquivHeaders, getHttpNameHeaders, getJavaScriptCodeSet, getJavaScriptSet, getJSHeaders, getJSONBridge, getPackVersion, getPageContext, getPageTitle, getPageZone, getPortal, getPortalCategory, getPortlet, getPublication, getStyleHeaders, getTemplateUsage, internalSetupEmptyHeader, isEditIcon, isPrintView, registerDisplayContext, removeAjaxRequestAttribute, setAjaxRequestAttribute, setAjaxRequestId, setAllHeadersDiffMap, setDocType, setEditIcon, setFormElementCount, setPageContext, setPageTitle, setPageZone, setShowEditIcon, setTemplateUsage, showEditIcon, workaroundBrowserBaseHrefBug

Methods inherited from class com.jalios.jcms.context.JcmsContext

addCookie, forceWorkspaceUpdate, getBaseUrl, getBrowser, getCaddy, getContextPath, getErrorMsg, getErrorMsgSession, getInfoMsg, getInfoMsgSession, getLoggedMember, getRequest, getResponse, getSession, getUploadedFile, getUploadedFileList, getUrlWithCommonUpdatedParams, getUserLang, getUserLocale, getWarningMsg, getWarningMsgSession, glp, isAdmin, isAjaxRequest, isDBMember, isDebug, isInFrontOffice, isLogged, isWebdavAccess, retrieveUploadedFile, sendForbidden, sendForbidden, sendRedirect, sendRedirect, setErrorMsg, setErrorMsg, setErrorMsgSession, setErrorMsgSession, setInfoMsg, setInfoMsg, setInfoMsgSession, setInfoMsgSession, setLoggedMember, setRequest, setResponse, setWarningMsg, setWarningMsg, setWarningMsgSession, setWarningMsgSession, validateRegexp

Methods inherited from class java.lang.Object

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

Field Detail

REVISION

public static final String REVISION

See Also:

Constant Field Values

Constructor Detail

PortletCalendarHandler

public PortletCalendarHandler()

Method Detail

init

public void init(PortalElement portlet)

getDayUrl

public String getDayUrl(PortalElement portlet,
                        Date date,
                        boolean inPortlet)

Parameters:

portlet - the portlet calendar in which result will be displayed (for action param)

date - the date of the day to wiew

inPortlet - a boolean to given portlet in full display true to show, false to let it the way it is

Returns:

a Url to view given day

getMonthUrl

public String getMonthUrl(PortalElement portlet,
                          Date date,
                          boolean inPortlet)

Returns:

a Url to view given month

getPortletCalendarEventDisplayURL

public static String getPortletCalendarEventDisplayURL(javax.servlet.http.HttpServletRequest request,
                                                       PortalElement portlet,
                                                       AbstractCalendarEvent calEv,
                                                       String view)

Parameters:

view - calendar view to use (day, workWeek, week or month)

Returns:

a Url to view the given calendar event in the given portlet calendar, in the specified view.

getTodayUrl

public String getTodayUrl()

Returns:

a Url to view today

getDayUrl

public String getDayUrl()

Returns:

a Url to view one day with current start date

getWorkWeekUrl

public String getWorkWeekUrl()

Returns:

a Url to view work week of current start date

getWeekUrl

public String getWeekUrl()

Returns:

a Url to view week of current start date

getMonthUrl

public String getMonthUrl()

Returns:

a Url to view month of current start date

getPreviousWeekUrl

public String getPreviousWeekUrl()

Returns:

a Url to view previous week

getNextWeekUrl

public String getNextWeekUrl()

Returns:

a Url to view next week

getPreviousDayUrl

public String getPreviousDayUrl()

Returns:

a Url to view previous day

getNextDayUrl

public String getNextDayUrl()

Returns:

a Url to view next day

getNDaysBeforeUrl

public String getNDaysBeforeUrl()

Returns:

a Url to view n days before current date, n corresponding to actual view

getNDaysAfterUrl

public String getNDaysAfterUrl()

Returns:

a Url to view n days after current date, n corresponding to actual view

getPreviousHourUrl

public String getPreviousHourUrl()

Returns:

a Url to view previous hour in current day

getNextHourUrl

public String getNextHourUrl()

Returns:

a Url to view next hour in current day

getPrevious6HourUrl

public String getPrevious6HourUrl()

Returns:

a Url to view previous hour in current day

getNext6HourUrl

public String getNext6HourUrl()

Returns:

a Url to view next hour in current day

getPreviousMonthUrl

public String getPreviousMonthUrl()

Returns:

a Url to view previous week

getNextMonthUrl

public String getNextMonthUrl()

Returns:

a Url to view next week

isMonthMode

public boolean isMonthMode()

isDaysMode

public boolean isDaysMode()

getStartDate

public Date getStartDate()

getEndDate

public Date getEndDate()

getMonthCal

public Calendar getMonthCal()

getHeader

public String getHeader()

setDefaultModeFromView

public void setDefaultModeFromView(String str)

Set defaults value given by portlet calendar

setDefaultDayStartHour

public void setDefaultDayStartHour(int startHour)

getDefaultDayStartHour

public int getDefaultDayStartHour()

setDefaultDayDuration

public void setDefaultDayDuration(int dayDuration)

getDefaultDayDuration

public int getDefaultDayDuration()

getCalMode

public String getCalMode()

get / set calendar mode as string

setCalMode

public void setCalMode(String modeStr)

getCalDayNbr

public int getCalDayNbr()

get / set number of day to display in days mode

setCalDayNbr

public void setCalDayNbr(int value)

getCalDate

public long getCalDate()

get / set start date as long

setCalDate

public void setCalDate(long dateL)

elements

public Enumeration elements()