org.apache.myfaces.custom.schedule
Class HtmlSchedule

java.lang.Object
  javax.faces.component.UIComponent
      javax.faces.component.UIComponentBase
          org.apache.myfaces.custom.schedule.AbstractUIScheduleBase
              org.apache.myfaces.custom.schedule.UIScheduleBase
                  org.apache.myfaces.custom.schedule.UISchedule
                      org.apache.myfaces.custom.schedule.AbstractHtmlSchedule
                          org.apache.myfaces.custom.schedule.HtmlSchedule

All Implemented Interfaces:

java.io.Serializable, javax.faces.component.ActionSource, javax.faces.component.StateHolder, javax.faces.component.ValueHolder, UserRoleAware

public class HtmlSchedule
extends AbstractHtmlSchedule
implements java.io.Serializable

See Also:

Serialized Form

Field Summary

static java.lang.String	COMPONENT_FAMILY
static java.lang.String	COMPONENT_TYPE
static java.lang.String	DEFAULT_RENDERER_TYPE

Fields inherited from class org.apache.myfaces.custom.schedule.AbstractUIScheduleBase

DEFAULT_COMPACT_MONTH_ROWHEIGHT, DEFAULT_COMPACT_WEEK_ROWHEIGHT, DEFAULT_DETAILED_ROWHEIGHT, DEFAULT_ENABLED_ON_USER_ROLE, DEFAULT_EXPAND_TO_FIT, DEFAULT_HEADER_DATE_FORMAT, DEFAULT_IMMEDIATE, DEFAULT_READONLY, DEFAULT_RENDER_ZEROLENGTH, DEFAULT_SPLIT_WEEKEND, DEFAULT_SUBMIT_ON_CLICK, DEFAULT_THEME, DEFAULT_TOOLTIP, DEFAULT_VISIBLE_END_HOUR, DEFAULT_VISIBLE_ON_USER_ROLE, DEFAULT_VISIBLE_START_HOUR, DEFAULT_WORKING_END_HOUR, DEFAULT_WORKING_START_HOUR, HOUR_NOTATION_12, HOUR_NOTATION_24, RENDERER_TYPE

Fields inherited from interface org.apache.myfaces.component.UserRoleAware

ENABLED_ON_USER_ROLE_ATTR, VISIBLE_ON_USER_ROLE_ATTR

Constructor Summary

HtmlSchedule()

Method Summary

java.lang.String	getBackgroundClass()
java.lang.String	getColumnClass()
java.lang.String	getContentClass()
java.lang.String	getDateClass()
java.lang.String	getDayClass()
java.lang.String	getEnabledOnUserRole() If user is in given role, this component will be rendered normally.
java.lang.String	getEntryClass()
java.lang.Object	getEntryRenderer()
java.lang.String	getEvenClass()
java.lang.String	getFamily()
java.lang.String	getForegroundClass()
java.lang.String	getFreeClass()
java.lang.String	getGutterClass()
java.lang.String	getHeaderClass()
java.lang.String	getHolidayClass()
java.lang.String	getHoursClass()
java.lang.String	getInactiveDayClass()
java.lang.String	getMinutesClass()
java.lang.String	getMonthClass()
java.lang.String	getSelectedClass()
java.lang.String	getSelectedEntryClass()
java.lang.String	getSubtitleClass()
java.lang.String	getTextClass()
java.lang.String	getTitleClass()
java.lang.String	getUnevenClass()
java.lang.String	getVisibleOnUserRole() If user is in given role, this component will be rendered normally.
java.lang.String	getWeekClass() the css class of the table representing a week in the compact mode (default: week)
void	restoreState(javax.faces.context.FacesContext facesContext, java.lang.Object state)
java.lang.Object	saveState(javax.faces.context.FacesContext facesContext)
void	setBackgroundClass(java.lang.String backgroundClass)
void	setColumnClass(java.lang.String columnClass)
void	setContentClass(java.lang.String contentClass)
void	setDateClass(java.lang.String dateClass)
void	setDayClass(java.lang.String dayClass)
void	setEnabledOnUserRole(java.lang.String enabledOnUserRole)
void	setEntryClass(java.lang.String entryClass)
void	setEntryRenderer(java.lang.Object entryRenderer)
void	setEvenClass(java.lang.String evenClass)
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	setHolidayClass(java.lang.String holidayClass)
void	setHoursClass(java.lang.String hoursClass)
void	setInactiveDayClass(java.lang.String inactiveDayClass)
void	setMinutesClass(java.lang.String minutesClass)
void	setMonthClass(java.lang.String monthClass)
void	setSelectedClass(java.lang.String selectedClass)
void	setSelectedEntryClass(java.lang.String selectedEntryClass)
void	setSubtitleClass(java.lang.String subtitleClass)
void	setTextClass(java.lang.String textClass)
void	setTitleClass(java.lang.String titleClass)
void	setUnevenClass(java.lang.String unevenClass)
void	setVisibleOnUserRole(java.lang.String visibleOnUserRole)
void	setWeekClass(java.lang.String weekClass)

Methods inherited from class org.apache.myfaces.custom.schedule.UISchedule

addActionListener, broadcast, findEntry, getAction, getActionListener, getActionListeners, getLastClickedDateAndTime, getMouseListener, getSubmittedEntry, queueEvent, removeActionListener, resetMouseEvents, setAction, setActionListener, setLastClickedDateAndTime, setMouseListener, setSubmittedEntry

Methods inherited from class org.apache.myfaces.custom.schedule.UIScheduleBase

getCompactMonthDayOfWeekDateFormat, getCompactMonthRowHeight, getCompactWeekRowHeight, getConverter, getDetailedRowHeight, getHeaderDateFormat, getHourNotation, getLocalValue, getTheme, getValue, getVisibleEndHour, getVisibleStartHour, getWorkingEndHour, getWorkingStartHour, isExpandToFitEntries, isImmediate, isReadonly, isRenderZeroLengthEntries, isSplitWeekend, isSubmitOnClick, isTooltip, setCompactMonthDayOfWeekDateFormat, setCompactMonthRowHeight, setCompactWeekRowHeight, setConverter, setDetailedRowHeight, setExpandToFitEntries, setHeaderDateFormat, setHourNotation, setImmediate, setReadonly, setRenderZeroLengthEntries, setSplitWeekend, setSubmitOnClick, setTheme, setTooltip, setValue, setVisibleEndHour, setVisibleStartHour, setWorkingEndHour, setWorkingStartHour

Methods inherited from class org.apache.myfaces.custom.schedule.AbstractUIScheduleBase

getModel, isRendersChildren, setModel

Methods inherited from class javax.faces.component.UIComponentBase

addFacesListener, decode, encodeBegin, encodeChildren, encodeEnd, findComponent, getAttributes, getChildCount, getChildren, getClientId, getFacesContext, getFacesListeners, getFacet, getFacets, getFacetsAndChildren, getId, getParent, getRenderer, getRendererType, getRendersChildren, getValueBinding, isRendered, isTransient, processDecodes, processRestoreState, processSaveState, processUpdates, processValidators, removeFacesListener, restoreAttachedState, saveAttachedState, setId, setParent, setRendered, setRendererType, setTransient, setValueBinding

Methods inherited from class java.lang.Object

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

Methods inherited from interface javax.faces.component.ActionSource

isImmediate, setImmediate

Field Detail

COMPONENT_FAMILY

public static final java.lang.String COMPONENT_FAMILY

See Also:

Constant Field Values

COMPONENT_TYPE

public static final java.lang.String COMPONENT_TYPE

See Also:

Constant Field Values

DEFAULT_RENDERER_TYPE

public static final java.lang.String DEFAULT_RENDERER_TYPE

See Also:

Constant Field Values

Constructor Detail

HtmlSchedule

public HtmlSchedule()

Method Detail

getFamily

public java.lang.String getFamily()

Overrides:

getFamily in class UIScheduleBase

See Also:

UIComponent.getFamily()

getBackgroundClass

public java.lang.String getBackgroundClass()

Specified by:

getBackgroundClass in class AbstractHtmlSchedule

Returns:

the backgroundClass

setBackgroundClass

public void setBackgroundClass(java.lang.String backgroundClass)

getColumnClass

public java.lang.String getColumnClass()

Specified by:

getColumnClass in class AbstractHtmlSchedule

Returns:

the columnClass

setColumnClass

public void setColumnClass(java.lang.String columnClass)

getContentClass

public java.lang.String getContentClass()

Specified by:

getContentClass in class AbstractHtmlSchedule

Returns:

the contentClass

setContentClass

public void setContentClass(java.lang.String contentClass)

getDateClass

public java.lang.String getDateClass()

Specified by:

getDateClass in class AbstractHtmlSchedule

Returns:

the dateClass

setDateClass

public void setDateClass(java.lang.String dateClass)

getDayClass

public java.lang.String getDayClass()

Specified by:

getDayClass in class AbstractHtmlSchedule

Returns:

the dayClass

setDayClass

public void setDayClass(java.lang.String dayClass)

getEntryClass

public java.lang.String getEntryClass()

Specified by:

getEntryClass in class AbstractHtmlSchedule

Returns:

the entryClass

setEntryClass

public void setEntryClass(java.lang.String entryClass)

getEntryRenderer

public java.lang.Object getEntryRenderer()

Specified by:

getEntryRenderer in class AbstractHtmlSchedule

Returns:

the entryRenderer

setEntryRenderer

public void setEntryRenderer(java.lang.Object entryRenderer)

getEvenClass

public java.lang.String getEvenClass()

Specified by:

getEvenClass in class AbstractHtmlSchedule

Returns:

the evenClass

setEvenClass

public void setEvenClass(java.lang.String evenClass)

getForegroundClass

public java.lang.String getForegroundClass()

Specified by:

getForegroundClass in class AbstractHtmlSchedule

Returns:

the foregroundClass

setForegroundClass

public void setForegroundClass(java.lang.String foregroundClass)

getFreeClass

public java.lang.String getFreeClass()

Specified by:

getFreeClass in class AbstractHtmlSchedule

Returns:

the freeClass

setFreeClass

public void setFreeClass(java.lang.String freeClass)

getGutterClass

public java.lang.String getGutterClass()

Specified by:

getGutterClass in class AbstractHtmlSchedule

Returns:

the gutterClass

setGutterClass

public void setGutterClass(java.lang.String gutterClass)

getHeaderClass

public java.lang.String getHeaderClass()

Specified by:

getHeaderClass in class AbstractHtmlSchedule

Returns:

the headerClass

setHeaderClass

public void setHeaderClass(java.lang.String headerClass)

getHolidayClass

public java.lang.String getHolidayClass()

Specified by:

getHolidayClass in class AbstractHtmlSchedule

Returns:

the holidayClass

setHolidayClass

public void setHolidayClass(java.lang.String holidayClass)

getHoursClass

public java.lang.String getHoursClass()

Specified by:

getHoursClass in class AbstractHtmlSchedule

Returns:

the hoursClass

setHoursClass

public void setHoursClass(java.lang.String hoursClass)

getInactiveDayClass

public java.lang.String getInactiveDayClass()

Specified by:

getInactiveDayClass in class AbstractHtmlSchedule

Returns:

the inactiveDayClass

setInactiveDayClass

public void setInactiveDayClass(java.lang.String inactiveDayClass)

getMinutesClass

public java.lang.String getMinutesClass()

Specified by:

getMinutesClass in class AbstractHtmlSchedule

Returns:

the minutesClass

setMinutesClass

public void setMinutesClass(java.lang.String minutesClass)

getMonthClass

public java.lang.String getMonthClass()

Specified by:

getMonthClass in class AbstractHtmlSchedule

Returns:

the monthClass

setMonthClass

public void setMonthClass(java.lang.String monthClass)

getSelectedClass

public java.lang.String getSelectedClass()

Specified by:

getSelectedClass in class AbstractHtmlSchedule

Returns:

the selectedClass

setSelectedClass

public void setSelectedClass(java.lang.String selectedClass)

getSelectedEntryClass

public java.lang.String getSelectedEntryClass()

Specified by:

getSelectedEntryClass in class AbstractHtmlSchedule

Returns:

the selectedEntryClass

setSelectedEntryClass

public void setSelectedEntryClass(java.lang.String selectedEntryClass)

getSubtitleClass

public java.lang.String getSubtitleClass()

Specified by:

getSubtitleClass in class AbstractHtmlSchedule

Returns:

the subtitleClass

setSubtitleClass

public void setSubtitleClass(java.lang.String subtitleClass)

getTextClass

public java.lang.String getTextClass()

Specified by:

getTextClass in class AbstractHtmlSchedule

Returns:

the textClass

setTextClass

public void setTextClass(java.lang.String textClass)

getTitleClass

public java.lang.String getTitleClass()

Specified by:

getTitleClass in class AbstractHtmlSchedule

Returns:

the titleClass

setTitleClass

public void setTitleClass(java.lang.String titleClass)

getUnevenClass

public java.lang.String getUnevenClass()

Specified by:

getUnevenClass in class AbstractHtmlSchedule

Returns:

the unevenClass

setUnevenClass

public void setUnevenClass(java.lang.String unevenClass)

getWeekClass

public java.lang.String getWeekClass()

Description copied from class: AbstractHtmlSchedule

the css class of the table representing a week in the compact mode (default: week)

Specified by:

getWeekClass in class AbstractHtmlSchedule

Returns:

the weekClass

setWeekClass

public void setWeekClass(java.lang.String weekClass)

getEnabledOnUserRole

public java.lang.String getEnabledOnUserRole()

Description copied from interface: UserRoleAware

If user is in given role, this component will be rendered normally. If not, no hyperlink is rendered but all nested tags (=body) are rendered.

Specified by:

getEnabledOnUserRole in interface UserRoleAware

Returns:

setEnabledOnUserRole

public void setEnabledOnUserRole(java.lang.String enabledOnUserRole)

Specified by:

setEnabledOnUserRole in interface UserRoleAware

getVisibleOnUserRole

public java.lang.String getVisibleOnUserRole()

Description copied from interface: UserRoleAware

If user is in given role, this component will be rendered normally. If not, nothing is rendered and the body of this tag will be skipped.

Specified by:

getVisibleOnUserRole in interface UserRoleAware

Returns:

setVisibleOnUserRole

public void setVisibleOnUserRole(java.lang.String visibleOnUserRole)

Specified by:

setVisibleOnUserRole in interface UserRoleAware

saveState

public java.lang.Object saveState(javax.faces.context.FacesContext facesContext)

Specified by:

saveState in interface javax.faces.component.StateHolder

Overrides:

saveState in class UISchedule

See Also:

UIScheduleBase.saveState(javax.faces.context.FacesContext)

restoreState

public void restoreState(javax.faces.context.FacesContext facesContext,
                         java.lang.Object state)

Specified by:

restoreState in interface javax.faces.component.StateHolder

Overrides:

restoreState in class UISchedule

See Also:

UIScheduleBase.restoreState(javax.faces.context.FacesContext, java.lang.Object)