org.opencms.jsp.util

Class CmsJspInstanceDateBean

java.lang.Object

org.opencms.jsp.util.CmsJspInstanceDateBean

public class CmsJspInstanceDateBean
extends java.lang.Object

Bean for easy access to information for single events.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	CmsJspInstanceDateBean.CmsDateFormatOption Formatting options for dates.
class	CmsJspInstanceDateBean.CmsDateFormatTransformer Transformer from formatting options to formatted dates.

Constructor Summary

Constructors

Constructor and Description
CmsJspInstanceDateBean(java.util.Date start, CmsJspDateSeriesBean series) Constructor taking start and end time for the single event.
CmsJspInstanceDateBean(java.util.Date date, java.util.Locale locale) Constructor to wrap a single date as instance date.

Method Summary

Modifier and Type	Method and Description
java.util.Date	getEnd() Returns the end time of the event.
CmsJspInstanceDateBean	getEndInstance() Returns an instance date bean wrapping only the end date of the original bean.
java.util.Map<java.lang.String,java.lang.String>	getFormat() Returns a lazy map from date format options to dates.
java.lang.String	getFormatLong() Returns the start and end dates/times as "start - end" in long date format and short time format specific for the request locale.
java.lang.String	getFormatShort() Returns the start and end dates/times as "start - end" in short date/time format specific for the request locale.
boolean	getIsSet() Check, if the start date of the instance date is 0 milliseconds.
java.util.Date	getLastDay() Returns some time of the last day, the event takes place.
java.util.Date	getStart() Returns the start time of the event.
CmsJspInstanceDateBean	getStartInstance() Returns an instance date bean wrapping only the start date of the original bean.
boolean	isMultiDay() Returns a flag, indicating if the event last over night.
boolean	isWholeDay() Returns a flag, indicating if the event lasts whole days.
void	setEnd(java.util.Date endDate) Explicitly set the end time of the event.
void	setWholeDay(java.lang.Boolean isWholeDay) Explicitly set if the single event is whole day.

Methods inherited from class java.lang.Object

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

Constructor Detail

CmsJspInstanceDateBean

public CmsJspInstanceDateBean(java.util.Date start,
                              CmsJspDateSeriesBean series)

Constructor taking start and end time for the single event.

Parameters:

start - the start time of the event.

series - the series, the event is part of.

CmsJspInstanceDateBean

public CmsJspInstanceDateBean(java.util.Date date,
                              java.util.Locale locale)

Constructor to wrap a single date as instance date. This will allow to use the format options.

Parameters:

date - the date to wrap

locale - the locale to use for formatting the date.

Method Detail

getEnd

public java.util.Date getEnd()

Returns the end time of the event.

Returns:

the end time of the event.

getEndInstance

public CmsJspInstanceDateBean getEndInstance()

Returns an instance date bean wrapping only the end date of the original bean.

Returns:

an instance date bean wrapping only the end date of the original bean.

getFormat

public java.util.Map<java.lang.String,java.lang.String> getFormat()

Returns a lazy map from date format options to dates. Supported formats are the values of CmsJspInstanceDateBean.CmsDateFormatOption.

Each option must be backed up by four three keys in the message "bundle org.opencms.jsp.util.messages" for you locale: GUI_PATTERN_DATE_{Option}, GUI_PATTERN_DATE_TIME_{Option} and GUI_PATTERN_TIME_{Option}.

Returns:

a lazy map from date patterns to dates.

getFormatLong

public java.lang.String getFormatLong()

Returns the start and end dates/times as "start - end" in long date format and short time format specific for the request locale.

Returns:

the formatted date/time string.

getFormatShort

public java.lang.String getFormatShort()

Returns the start and end dates/times as "start - end" in short date/time format specific for the request locale.

Returns:

the formatted date/time string.

getIsSet

public boolean getIsSet()

Check, if the start date of the instance date is 0 milliseconds. If this is the case, we assume the instance date is not set.

Returns:

a flag, indicating if the instance date is set.

getLastDay

public java.util.Date getLastDay()

Returns some time of the last day, the event takes place.

For whole day events the end date is adjusted by subtracting one day, since it would otherwise be the 12 am of the first day, the event does not take place anymore.

Returns:

some time of the last day, the event takes place.

getStart

public java.util.Date getStart()

Returns the start time of the event.

Returns:

the start time of the event.

getStartInstance

public CmsJspInstanceDateBean getStartInstance()

Returns an instance date bean wrapping only the start date of the original bean.

Returns:

an instance date bean wrapping only the start date of the original bean.

isMultiDay

public boolean isMultiDay()

Returns a flag, indicating if the event last over night.

Returns:

true if the event ends on another day than it starts, false if it ends on the same day.

isWholeDay

public boolean isWholeDay()

Returns a flag, indicating if the event lasts whole days.

Returns:

a flag, indicating if the event lasts whole days.

setEnd

public void setEnd(java.util.Date endDate)

Explicitly set the end time of the event. If the provided date is null or a date before the start date, the end date defaults to the start date.

Parameters:

endDate - the end time of the event.

setWholeDay

public void setWholeDay(java.lang.Boolean isWholeDay)

Explicitly set if the single event is whole day.

Parameters:

isWholeDay - flag, indicating if the single event lasts the whole day. If null the value defaults to the setting from the underlying date series.