Class WeeklyCalendarTag

java.lang.Object

jakarta.servlet.jsp.tagext.TagSupport

org.deltava.taglib.calendar.CalendarTag

org.deltava.taglib.calendar.WeeklyCalendarTag

All Implemented Interfaces:

jakarta.servlet.jsp.tagext.IterationTag, jakarta.servlet.jsp.tagext.JspTag, jakarta.servlet.jsp.tagext.Tag, Serializable

public class WeeklyCalendarTag
extends CalendarTag

A JSP tag to generate a weekly Calendar.

Since:

1.0

Version:

12.3

Author:

Luke

See Also:

• Serialized Form

Field Summary

Fields inherited from class CalendarTag

_border, _contentClass, _currentDate, _day, _dayBarClass, _endDate, _entries, _intervalLength, _intervalType, _out, _showDaysOfWeek, _startDate, _table, _tableClass, _tableID, _today, _topBarClass, _tz

Modifier and Type	Field	Description
protected int	_border
protected String	_contentClass
protected ZonedDateTime	_currentDate
protected XMLRenderer	_day
protected String	_dayBarClass
protected ZonedDateTime	_endDate
protected final Collection<CalendarEntry>	_entries
protected int	_intervalLength
protected ChronoUnit	_intervalType
protected jakarta.servlet.jsp.JspWriter	_out
protected boolean	_showDaysOfWeek
protected ZonedDateTime	_startDate
protected XMLRenderer	_table
protected String	_tableClass
protected String	_tableID
protected ZonedDateTime	_today
protected String	_topBarClass
protected ZoneId	_tz

Fields inherited from class jakarta.servlet.jsp.tagext.TagSupport

id, pageContext

Fields inherited from interface jakarta.servlet.jsp.tagext.IterationTag

EVAL_BODY_AGAIN

Fields inherited from interface jakarta.servlet.jsp.tagext.Tag

EVAL_BODY_INCLUDE, EVAL_PAGE, SKIP_BODY, SKIP_PAGE

Constructor Summary

Constructors

Constructor	Description
WeeklyCalendarTag()

Method Summary

Modifier and Type	Method	Description
int	doAfterBody()	Executed after the end of each day.
int	doEndTag()	Closes the calendar table.
int	doStartTag()	Renders the Calendar header to the JSP output stream.
protected String	getBackLabel()	Returns the label for the scroll backwards link.
protected String	getForwardLabel()	Returns the label for the scroll forwards link
void	setStartDate(ZonedDateTime dt)	Sets the starting date for this calendar tag.

Methods inherited from class CalendarTag

calculateEndDate, getContentClass, getCurrentEntries, getHeaderClass, multiFilter, release, setBorder, setCmd, setContentClass, setDate, setDayBarClass, setEntries, setMultipleDays, setPageContext, setScrollClass, setScrollTags, setShowDaysOfWeek, setTableClass, setTableID, setTopBarClass

Modifier and Type	Method	Description
protected void	calculateEndDate(ChronoUnit intervalType, int amount)	Calculates the end date based on the start date and a particular interval amount.
protected String	getContentClass(ZonedDateTime dt)	Calculates the CSS class(es) for the content table cell.
(package private) Collection<CalendarEntry>	getCurrentEntries()	Returns all Calendar entries for the currently rendered Date, from midnight to 11:59PM.
protected String	getHeaderClass(ZonedDateTime dt)	Calculates the CSS class(es) for the header table cell.
static boolean	multiFilter(CalendarEntry ce, DateRange dr)
void	release()
void	setBorder(int border)	Sets the BORDER value for this table.
void	setCmd(String cmdName)	Sets the command name to use when scrolling the view.
void	setContentClass(String cName)	Sets the CSS class name for the view table content bar.
void	setDate(String attrName)	Sets the request attribute name for the current date.
void	setDayBarClass(String cName)	Sets the CSS class name for the view table day bar.
final void	setEntries(Collection<CalendarEntry> entries)	Sets the entries to display in this calendar view table.
void	setMultipleDays(boolean doMultiDays)	Sets whether to include an entry that spans multiple days to be included on each day.
void	setPageContext(jakarta.servlet.jsp.PageContext ctx)	Sets the page context for the tag, and sets the user's time zone.
void	setScrollClass(String cName)	Sets the CSS class name for the forwad/backward scroll links.
void	setScrollTags(boolean showScroll)	Sets whether to display the forward/backward scroll tags.
void	setShowDaysOfWeek(boolean showDOW)	Sets whether the days of the week should be displayed below the title bar.
void	setTableClass(String cName)	Sets the CSS class name for the view table.
void	setTableID(String id)	Sets the CSS ID for the view table.
void	setTopBarClass(String cName)	Sets the CSS class name for the view table title bar.

Methods inherited from class jakarta.servlet.jsp.tagext.TagSupport

findAncestorWithClass, getId, getParent, getValue, getValues, removeValue, setId, setParent, setValue

Methods inherited from class Object

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

Constructor Details

WeeklyCalendarTag

public WeeklyCalendarTag()

Method Details

setStartDate

public void setStartDate(ZonedDateTime dt)

Sets the starting date for this calendar tag. This is overriden to be the first day of the week (Sunday).

Specified by:

setStartDate in class CalendarTag

Parameters:

dt - the start date

See Also:

• CalendarTag.setStartDate(ZonedDateTime)

getBackLabel

protected String getBackLabel()

Description copied from class: CalendarTag

Returns the label for the scroll backwards link.

Specified by:

getBackLabel in class CalendarTag

Returns:

the link label

See Also:

• CalendarTag.getForwardLabel()

getForwardLabel

protected String getForwardLabel()

Description copied from class: CalendarTag

Returns the label for the scroll forwards link

Specified by:

getForwardLabel in class CalendarTag

Returns:

the link label

See Also:

• CalendarTag.getBackLabel()

doStartTag

public int doStartTag()
               throws jakarta.servlet.jsp.JspException

Renders the Calendar header to the JSP output stream.

Specified by:

doStartTag in interface jakarta.servlet.jsp.tagext.Tag

Overrides:

doStartTag in class CalendarTag

Returns:

TagSupport.EVAL_BODY_INCLUDE always

Throws:

jakarta.servlet.jsp.JspException - if an I/O error occurs

doAfterBody

public int doAfterBody()
                throws jakarta.servlet.jsp.JspException

Executed after the end of each day. The day table cell is closed and the superclass tag is called to determine if further records are required.

Specified by:

doAfterBody in interface jakarta.servlet.jsp.tagext.IterationTag

Overrides:

doAfterBody in class CalendarTag

Returns:

TagSupport.EVAL_BODY_AGAIN if not at end of month, otherwise TagSupport.SKIP_BODY

Throws:

jakarta.servlet.jsp.JspException - never

doEndTag

public int doEndTag()
             throws jakarta.servlet.jsp.JspException

Closes the calendar table.

Specified by:

doEndTag in interface jakarta.servlet.jsp.tagext.Tag

Overrides:

doEndTag in class CalendarTag

Returns:

TagSupport.EVAL_PAGE always

Throws:

jakarta.servlet.jsp.JspException - if an I/O error occurs