org.jasig.schedassist.portlet
Class VisibleScheduleTag

java.lang.Object
  javax.servlet.jsp.tagext.TagSupport
      org.springframework.web.servlet.tags.RequestContextAwareTag
          org.jasig.schedassist.portlet.VisibleScheduleTag

All Implemented Interfaces:

Serializable, javax.servlet.jsp.tagext.IterationTag, javax.servlet.jsp.tagext.JspTag, javax.servlet.jsp.tagext.Tag, javax.servlet.jsp.tagext.TryCatchFinally

public class VisibleScheduleTag
extends org.springframework.web.servlet.tags.RequestContextAwareTag

JSP tag for rendering a VisibleSchedule within the portlet.

Version:

$Id: VisibleScheduleTag.java 2345 2010-08-06 20:14:41Z npblair $

Author:

Nicholas Blair, nblair@doit.wisc.edu

See Also:

Serialized Form

Field Summary

protected static String	PORTLET_REQUEST
protected static String	PORTLET_RESPONSE

Fields inherited from class org.springframework.web.servlet.tags.RequestContextAwareTag

logger, REQUEST_CONTEXT_PAGE_ATTRIBUTE

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

id, pageContext

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

EVAL_BODY_AGAIN

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

EVAL_BODY_INCLUDE, EVAL_PAGE, SKIP_BODY, SKIP_PAGE

Constructor Summary

VisibleScheduleTag()

Method Summary

int	doEndTag()
protected boolean	doesWeekHaveBlocks(Map<Date,List<AvailableBlock>> dailySchedules) Inspects the List of AvailableBlock for each map key between the start and end arguments.
int	doStartTagInternal()
org.springframework.context.MessageSource	getMessageSource()
protected String	getSilkIconPrefix()
protected void	renderAttendingBlock(javax.servlet.jsp.JspWriter writer, AvailableBlock event, javax.portlet.RenderRequest renderRequest, javax.portlet.RenderResponse renderResponse) Render a single AvailableBlock with AvailableStatus.ATTENDING.
protected void	renderBusyBlock(javax.servlet.jsp.JspWriter writer, AvailableBlock event) Render a single AvailableBlock with AvailableStatus.BUSY.
protected void	renderFreeBlock(javax.servlet.jsp.JspWriter writer, AvailableBlock event, javax.portlet.RenderRequest renderRequest, javax.portlet.RenderResponse renderResponse) Render a single AvailableBlock with AvailableStatus.FREE.
protected void	renderWeek(javax.servlet.jsp.JspWriter writer, int weekNumber, SortedMap<Date,List<AvailableBlock>> dailySchedules, SortedMap<AvailableBlock,AvailableStatus> scheduleBlockMap, javax.portlet.RenderRequest renderRequest, javax.portlet.RenderResponse renderResponse) Render a single week.
void	setFlowExecutionKey(String flowExecutionKey)
void	setPreviewMode(boolean previewMode)
void	setResourceServerContext(String resourceServerContext)
void	setVisibleSchedule(VisibleSchedule visibleSchedule)

Methods inherited from class org.springframework.web.servlet.tags.RequestContextAwareTag

doCatch, doFinally, doStartTag, getRequestContext

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

doAfterBody, findAncestorWithClass, getId, getParent, getValue, getValues, release, removeValue, setId, setPageContext, setParent, setValue

Methods inherited from class java.lang.Object

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

Field Detail

PORTLET_REQUEST

protected static final String PORTLET_REQUEST

See Also:

Constant Field Values

PORTLET_RESPONSE

protected static final String PORTLET_RESPONSE

See Also:

Constant Field Values

Constructor Detail

VisibleScheduleTag

public VisibleScheduleTag()

Method Detail

setVisibleSchedule

public void setVisibleSchedule(VisibleSchedule visibleSchedule)

Parameters:

visibleSchedule - the visibleSchedule to set

setPreviewMode

public void setPreviewMode(boolean previewMode)

Parameters:

previewMode - the previewMode to set

setResourceServerContext

public void setResourceServerContext(String resourceServerContext)

Parameters:

resourceServerContext - the resourceServerContext to set

setFlowExecutionKey

public void setFlowExecutionKey(String flowExecutionKey)

Parameters:

flowExecutionKey - the flowExecutionKey to set

getMessageSource

public org.springframework.context.MessageSource getMessageSource()

Returns:

the MessageSource

getSilkIconPrefix

protected String getSilkIconPrefix()

Returns:

the path to the silk icons directory, including the resourceServerContext

doEndTag

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

Specified by:

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

Overrides:

doEndTag in class javax.servlet.jsp.tagext.TagSupport

Throws:

javax.servlet.jsp.JspException

doStartTagInternal

public int doStartTagInternal()

Specified by:

doStartTagInternal in class org.springframework.web.servlet.tags.RequestContextAwareTag

doesWeekHaveBlocks

protected boolean doesWeekHaveBlocks(Map<Date,List<AvailableBlock>> dailySchedules)

Inspects the List of AvailableBlock for each map key between the start and end arguments. If any List for those keys is not empty, return true.

Parameters:

dailySchedules -

start -

end -

Returns:

true if any blocks exist between start and end; false if none.

renderWeek

protected void renderWeek(javax.servlet.jsp.JspWriter writer,
                          int weekNumber,
                          SortedMap<Date,List<AvailableBlock>> dailySchedules,
                          SortedMap<AvailableBlock,AvailableStatus> scheduleBlockMap,
                          javax.portlet.RenderRequest renderRequest,
                          javax.portlet.RenderResponse renderResponse)
                   throws IOException

Render a single week.

Parameters:

writer -

weekNumber -

dailySchedules -

scheduleBlockMap -

renderRequest -

renderResponse -

Throws:

IOException

renderBusyBlock

protected void renderBusyBlock(javax.servlet.jsp.JspWriter writer,
                               AvailableBlock event)
                        throws IOException

Render a single AvailableBlock with AvailableStatus.BUSY.

Parameters:

writer -

event -

Throws:

IOException

renderFreeBlock

protected void renderFreeBlock(javax.servlet.jsp.JspWriter writer,
                               AvailableBlock event,
                               javax.portlet.RenderRequest renderRequest,
                               javax.portlet.RenderResponse renderResponse)
                        throws IOException

Render a single AvailableBlock with AvailableStatus.FREE.

Parameters:

writer -

event -

renderRequest -

renderResponse -

Throws:

IOException

renderAttendingBlock

protected void renderAttendingBlock(javax.servlet.jsp.JspWriter writer,
                                    AvailableBlock event,
                                    javax.portlet.RenderRequest renderRequest,
                                    javax.portlet.RenderResponse renderResponse)
                             throws IOException

Render a single AvailableBlock with AvailableStatus.ATTENDING.

Parameters:

writer -

event -

renderRequest -

renderResponse -

Throws:

IOException