org.apache.myfaces.custom.schedule
Class ScheduleTag

java.lang.Object
  extended by javax.faces.webapp.UIComponentTag
      extended by org.apache.myfaces.custom.schedule.ScheduleTag
All Implemented Interfaces:
java.io.Serializable, javax.servlet.jsp.tagext.JspTag, javax.servlet.jsp.tagext.Tag

public class ScheduleTag
extends javax.faces.webapp.UIComponentTag
implements java.io.Serializable

JSP tag for the schedule component

Version:
$Revision: 392301 $
Author:
Jurgen Lust (latest modification by $Author: jlust $)
See Also:
Serialized Form

Field Summary
 
Fields inherited from class javax.faces.webapp.UIComponentTag
pageContext
 
Fields inherited from interface javax.servlet.jsp.tagext.Tag
EVAL_BODY_INCLUDE, EVAL_PAGE, SKIP_BODY, SKIP_PAGE
 
Constructor Summary
ScheduleTag()
           
 
Method Summary
 java.lang.String getAction()
           The action of the JSF component
 java.lang.String getActionListener()
           The actionlistener of the JSF component
 java.lang.String getBackgroundClass()
           
 java.lang.String getColumnClass()
           
 java.lang.String getCompactMonthRowHeight()
           The height in pixels of a cell in the compact month view
 java.lang.String getCompactWeekRowHeight()
           The height in pixels of a cell in the compact week view
 java.lang.String getComponentType()
           
 java.lang.String getContentClass()
           
 java.lang.String getDateClass()
           
 java.lang.String getDayClass()
           
 java.lang.String getDetailedRowHeight()
          The height in pixels of a cell in the detailed day view
 java.lang.String getEntryClass()
           
 java.lang.String getEntryRenderer()
           
 java.lang.String getEvenClass()
           
 java.lang.String getExpandToFitEntries()
           By default, if an appointment exists outside the visibleStartHour/visibleEndHour limits, it does not appear in the day or workweek modes.
 java.lang.String getForegroundClass()
           
 java.lang.String getFreeClass()
           
 java.lang.String getGutterClass()
           
 java.lang.String getHeaderClass()
           
 java.lang.String getHeaderDateFormat()
           The dateformat used in the header
 java.lang.String getHolidayClass()
           
 java.lang.String getHoursClass()
           
 java.lang.String getImmediate()
           The immediate property of the JSF component
 java.lang.String getInactiveDayClass()
           
 java.lang.String getMinutesClass()
           
 java.lang.String getMonthClass()
           
 java.lang.String getMouseListener()
           
 java.lang.String getReadonly()
           The readonly property of the JSF component
 java.lang.String getRendered()
           Should this component be rendered?
 java.lang.String getRendererType()
           
 java.lang.String getRenderZeroLengthEntries()
           When the start- and endtime of an entry are the same, should the entry be rendered, fitting the entry box to the text?
 java.lang.String getSelectedClass()
           
 java.lang.String getSelectedEntryClass()
           
 java.lang.String getSubmitOnClick()
           Should the parent form of this schedule be submitted when the user clicks on a day? Note that this will only work when the readonly property is set to false.
 java.lang.String getSubtitleClass()
           
 java.lang.String getTextClass()
           
 java.lang.String getTheme()
           The theme of the schedule component.
 java.lang.String getTitleClass()
           
 java.lang.String getTooltip()
           Should tooltips be displayed?
 java.lang.String getUnevenClass()
           
 java.lang.String getValue()
           The value of the JSF component
 java.lang.String getVisibleEndHour()
           The visible end hour of the schedule
 java.lang.String getVisibleStartHour()
           The visible start hour of the schedule
 java.lang.String getWeekClass()
           
 java.lang.String getWorkingEndHour()
           The working end hour of the schedule
 java.lang.String getWorkingStartHour()
           The working start hour of the schedule
 void release()
           
 void setAction(java.lang.String action)
           The action of the JSF component
 void setActionListener(java.lang.String actionListener)
           The actionlistener of the JSF component
 void setBackgroundClass(java.lang.String backgroundClass)
           
 void setColumnClass(java.lang.String columnClass)
           
 void setCompactMonthRowHeight(java.lang.String compactMonthRowHeight)
           The height in pixels of a cell in the compact month view
 void setCompactWeekRowHeight(java.lang.String compactWeekRowHeight)
           The height in pixels of a cell in the compact week view
 void setContentClass(java.lang.String contentClass)
           
 void setDateClass(java.lang.String dateClass)
           
 void setDayClass(java.lang.String dayClass)
           
 void setDetailedRowHeight(java.lang.String detailedRowHeight)
          The height in pixels of a cell in the detailed day view
 void setEntryClass(java.lang.String entryClass)
           
 void setEntryRenderer(java.lang.String entryRenderer)
           
 void setEvenClass(java.lang.String evenClass)
           
 void setExpandToFitEntries(java.lang.String expandToFitEntries)
           By default, if an appointment exists outside the visibleStartHour/visibleEndHour limits, it does not appear in the day or workweek modes.
 void setForegroundClass(java.lang.String foregroundClass)
           
 void setFreeClass(java.lang.String freeClass)
           
 void setGutterClass(java.lang.String gutterClass)
           
 void setHeaderClass(java.lang.String headerClass)
           
 void setHeaderDateFormat(java.lang.String headerDateFormat)
           The dateformat used in the header
 void setHolidayClass(java.lang.String holidayClass)
           
 void setHoursClass(java.lang.String hoursClass)
           
 void setImmediate(java.lang.String immediate)
           The immediate property of the JSF component
 void setInactiveDayClass(java.lang.String inactiveDayClass)
           
 void setMinutesClass(java.lang.String minutesClass)
           
 void setMonthClass(java.lang.String monthClass)
           
 void setMouseListener(java.lang.String mouseListener)
           
protected  void setProperties(javax.faces.component.UIComponent component)
           
 void setReadonly(java.lang.String readonly)
           The readonly property of the JSF component
 void setRendered(java.lang.String rendered)
           Should this component be rendered?
 void setRenderZeroLengthEntries(java.lang.String render)
           When the start- and endtime of an entry are the same, should the entry be rendered, fitting the entry box to the text?
 void setSelectedClass(java.lang.String selectedClass)
           
 void setSelectedEntryClass(java.lang.String selectedEntryClass)
           
 void setSubmitOnClick(java.lang.String submitOnClick)
           Should the parent form of this schedule be submitted when the user clicks on a day? Note that this will only work when the readonly property is set to false.
 void setSubtitleClass(java.lang.String subtitleClass)
           
 void setTextClass(java.lang.String textClass)
           
 void setTheme(java.lang.String theme)
           The theme of the schedule component.
 void setTitleClass(java.lang.String titleClass)
           
 void setTooltip(java.lang.String tooltip)
           Should tooltips be displayed?
 void setUnevenClass(java.lang.String unevenClass)
           
 void setValue(java.lang.String value)
           The value of the JSF component
 void setVisibleEndHour(java.lang.String visibleEndHour)
           The visible end hour of the schedule
 void setVisibleStartHour(java.lang.String visibleStartHour)
           The visible start hour of the schedule
 void setWeekClass(java.lang.String weekClass)
           
 void setWorkingEndHour(java.lang.String workingEndHour)
           The working end hour of the schedule
 void setWorkingStartHour(java.lang.String workingStartHour)
           The working start hour of the schedule
 
Methods inherited from class javax.faces.webapp.UIComponentTag
doEndTag, doStartTag, encodeBegin, encodeChildren, encodeEnd, findComponent, getComponentInstance, getCreated, getDoEndValue, getDoStartValue, getFacesContext, getFacetName, getId, getParent, getParentUIComponentTag, isSuppressed, isValueReference, setBinding, setId, setPageContext, setParent, setupResponseWriter
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

ScheduleTag

public ScheduleTag()
Method Detail

getAction

public java.lang.String getAction()

The action of the JSF component

Returns:
Returns the action.

getActionListener

public java.lang.String getActionListener()

The actionlistener of the JSF component

Returns:
Returns the actionListener.

getBackgroundClass

public java.lang.String getBackgroundClass()

getColumnClass

public java.lang.String getColumnClass()

getCompactMonthRowHeight

public java.lang.String getCompactMonthRowHeight()

The height in pixels of a cell in the compact month view

Returns:
Returns the compactMonthRowHeight.

getCompactWeekRowHeight

public java.lang.String getCompactWeekRowHeight()

The height in pixels of a cell in the compact week view

Returns:
Returns the compactWeekRowHeight.

getComponentType

public java.lang.String getComponentType()
Specified by:
getComponentType in class javax.faces.webapp.UIComponentTag
See Also:
UIComponentTag.getComponentType()

getContentClass

public java.lang.String getContentClass()

getDateClass

public java.lang.String getDateClass()

getDayClass

public java.lang.String getDayClass()

getDetailedRowHeight

public java.lang.String getDetailedRowHeight()
The height in pixels of a cell in the detailed day view

Returns:
the detailedRowHeight

getEntryClass

public java.lang.String getEntryClass()

getEntryRenderer

public java.lang.String getEntryRenderer()

getEvenClass

public java.lang.String getEvenClass()

getForegroundClass

public java.lang.String getForegroundClass()

getFreeClass

public java.lang.String getFreeClass()

getGutterClass

public java.lang.String getGutterClass()

getHeaderClass

public java.lang.String getHeaderClass()

getHeaderDateFormat

public java.lang.String getHeaderDateFormat()

The dateformat used in the header

Returns:
Returns the headerDateFormat.

getHolidayClass

public java.lang.String getHolidayClass()

getHoursClass

public java.lang.String getHoursClass()

getImmediate

public java.lang.String getImmediate()

The immediate property of the JSF component

Returns:
Returns the immediate.

getInactiveDayClass

public java.lang.String getInactiveDayClass()

getMinutesClass

public java.lang.String getMinutesClass()

getMonthClass

public java.lang.String getMonthClass()

getMouseListener

public java.lang.String getMouseListener()

getReadonly

public java.lang.String getReadonly()

The readonly property of the JSF component

Returns:
Returns the readonly.

getRendered

public java.lang.String getRendered()

Should this component be rendered?

Returns:
Returns the rendered.

getRendererType

public java.lang.String getRendererType()
Specified by:
getRendererType in class javax.faces.webapp.UIComponentTag
See Also:
UIComponentTag.getRendererType()

getSelectedClass

public java.lang.String getSelectedClass()

getSelectedEntryClass

public java.lang.String getSelectedEntryClass()

getSubmitOnClick

public java.lang.String getSubmitOnClick()

Should the parent form of this schedule be submitted when the user clicks on a day? Note that this will only work when the readonly property is set to false.

Returns:
submit the form on mouse click

getSubtitleClass

public java.lang.String getSubtitleClass()

getTextClass

public java.lang.String getTextClass()

getTheme

public java.lang.String getTheme()

The theme of the schedule component. This is the name of the CSS file that should be loaded when rendering the schedule. Possible values are 'default', 'outlookxp', 'evolution'.

Returns:
Returns the theme.

getTitleClass

public java.lang.String getTitleClass()

getTooltip

public java.lang.String getTooltip()

Should tooltips be displayed?

Returns:
Returns the tooltip.

getUnevenClass

public java.lang.String getUnevenClass()

getValue

public java.lang.String getValue()

The value of the JSF component

Returns:
Returns the value.

getVisibleEndHour

public java.lang.String getVisibleEndHour()

The visible end hour of the schedule

Returns:
Returns the visibleEndHour.

getVisibleStartHour

public java.lang.String getVisibleStartHour()

The visible start hour of the schedule

Returns:
Returns the visibleStartHour.

getWeekClass

public java.lang.String getWeekClass()

getWorkingEndHour

public java.lang.String getWorkingEndHour()

The working end hour of the schedule

Returns:
Returns the workingEndHour.

getWorkingStartHour

public java.lang.String getWorkingStartHour()

The working start hour of the schedule

Returns:
Returns the workingStartHour.

release

public void release()
Specified by:
release in interface javax.servlet.jsp.tagext.Tag
Overrides:
release in class javax.faces.webapp.UIComponentTag
See Also:
Tag.release()

setAction

public void setAction(java.lang.String action)

The action of the JSF component

Parameters:
action - The action to set.

setActionListener

public void setActionListener(java.lang.String actionListener)

The actionlistener of the JSF component

Parameters:
actionListener - The actionListener to set.

setBackgroundClass

public void setBackgroundClass(java.lang.String backgroundClass)

setColumnClass

public void setColumnClass(java.lang.String columnClass)

setCompactMonthRowHeight

public void setCompactMonthRowHeight(java.lang.String compactMonthRowHeight)

The height in pixels of a cell in the compact month view

Parameters:
compactMonthRowHeight - The compactMonthRowHeight to set.

setCompactWeekRowHeight

public void setCompactWeekRowHeight(java.lang.String compactWeekRowHeight)

The height in pixels of a cell in the compact week view

Parameters:
compactWeekRowHeight - The compactWeekRowHeight to set.

setContentClass

public void setContentClass(java.lang.String contentClass)

setDateClass

public void setDateClass(java.lang.String dateClass)

setDayClass

public void setDayClass(java.lang.String dayClass)

setDetailedRowHeight

public void setDetailedRowHeight(java.lang.String detailedRowHeight)
The height in pixels of a cell in the detailed day view

Parameters:
detailedRowHeight - the detailedRowHeight

setEntryClass

public void setEntryClass(java.lang.String entryClass)

setEntryRenderer

public void setEntryRenderer(java.lang.String entryRenderer)

setEvenClass

public void setEvenClass(java.lang.String evenClass)

setForegroundClass

public void setForegroundClass(java.lang.String foregroundClass)

setFreeClass

public void setFreeClass(java.lang.String freeClass)

setGutterClass

public void setGutterClass(java.lang.String gutterClass)

setHeaderClass

public void setHeaderClass(java.lang.String headerClass)

setHeaderDateFormat

public void setHeaderDateFormat(java.lang.String headerDateFormat)

The dateformat used in the header

Parameters:
headerDateFormat - The headerDateFormat to set.

setHolidayClass

public void setHolidayClass(java.lang.String holidayClass)

setHoursClass

public void setHoursClass(java.lang.String hoursClass)

setImmediate

public void setImmediate(java.lang.String immediate)

The immediate property of the JSF component

Parameters:
immediate - The immediate to set.

setInactiveDayClass

public void setInactiveDayClass(java.lang.String inactiveDayClass)

setMinutesClass

public void setMinutesClass(java.lang.String minutesClass)

setMonthClass

public void setMonthClass(java.lang.String monthClass)

setMouseListener

public void setMouseListener(java.lang.String mouseListener)

setProperties

protected void setProperties(javax.faces.component.UIComponent component)
Overrides:
setProperties in class javax.faces.webapp.UIComponentTag
See Also:
UIComponentTag.setProperties(javax.faces.component.UIComponent)

setReadonly

public void setReadonly(java.lang.String readonly)

The readonly property of the JSF component

Parameters:
readonly - The readonly to set.

setRendered

public void setRendered(java.lang.String rendered)

Should this component be rendered?

Overrides:
setRendered in class javax.faces.webapp.UIComponentTag
Parameters:
rendered - The rendered to set.

setSelectedClass

public void setSelectedClass(java.lang.String selectedClass)

setSelectedEntryClass

public void setSelectedEntryClass(java.lang.String selectedEntryClass)

setSubmitOnClick

public void setSubmitOnClick(java.lang.String submitOnClick)

Should the parent form of this schedule be submitted when the user clicks on a day? Note that this will only work when the readonly property is set to false.

Parameters:
submitOnClick - submit the form on mouse click

setSubtitleClass

public void setSubtitleClass(java.lang.String subtitleClass)

setTextClass

public void setTextClass(java.lang.String textClass)

setTheme

public void setTheme(java.lang.String theme)

The theme of the schedule component. This is the name of the CSS file that should be loaded when rendering the schedule. Possible values are 'default', 'outlookxp', 'evolution'.

Parameters:
theme - The theme to set.

setTitleClass

public void setTitleClass(java.lang.String titleClass)

setTooltip

public void setTooltip(java.lang.String tooltip)

Should tooltips be displayed?

Parameters:
tooltip - The tooltip to set.

setUnevenClass

public void setUnevenClass(java.lang.String unevenClass)

setValue

public void setValue(java.lang.String value)

The value of the JSF component

Parameters:
value - The value to set.

setVisibleEndHour

public void setVisibleEndHour(java.lang.String visibleEndHour)

The visible end hour of the schedule

Parameters:
visibleEndHour - The visibleEndHour to set.

setVisibleStartHour

public void setVisibleStartHour(java.lang.String visibleStartHour)

The visible start hour of the schedule

Parameters:
visibleStartHour - The visibleStartHour to set.

setWeekClass

public void setWeekClass(java.lang.String weekClass)

setWorkingEndHour

public void setWorkingEndHour(java.lang.String workingEndHour)

The working end hour of the schedule

Parameters:
workingEndHour - The workingEndHour to set.

setWorkingStartHour

public void setWorkingStartHour(java.lang.String workingStartHour)

The working start hour of the schedule

Parameters:
workingStartHour - The workingStartHour to set.

getRenderZeroLengthEntries

public java.lang.String getRenderZeroLengthEntries()

When the start- and endtime of an entry are the same, should the entry be rendered, fitting the entry box to the text?

Returns:
rendered or not

setRenderZeroLengthEntries

public void setRenderZeroLengthEntries(java.lang.String render)

When the start- and endtime of an entry are the same, should the entry be rendered, fitting the entry box to the text?

Parameters:
render -

getExpandToFitEntries

public java.lang.String getExpandToFitEntries()

By default, if an appointment exists outside the visibleStartHour/visibleEndHour limits, it does not appear in the day or workweek modes. This setting checks for events outside the visible range and extends the visible range to display the events. If events only occur within the visible range, then no adjustment is made.

Returns:
Returns the expandToFitEntries.

setExpandToFitEntries

public void setExpandToFitEntries(java.lang.String expandToFitEntries)

By default, if an appointment exists outside the visibleStartHour/visibleEndHour limits, it does not appear in the day or workweek modes. This setting checks for events outside the visible range and extends the visible range to display the events. If events only occur within the visible range, then no adjustment is made.

Parameters:
expandToFitEntries - The expandToFitEntries to set.


Copyright © 2011. All Rights Reserved.