org.apache.myfaces.custom.schedule
Class AbstractHtmlSchedule

java.lang.Object
  extended by javax.faces.component.UIComponent
      extended by javax.faces.component.UIComponentBase
          extended by org.apache.myfaces.custom.schedule.AbstractUIScheduleBase
              extended by org.apache.myfaces.custom.schedule.UIScheduleBase
                  extended by org.apache.myfaces.custom.schedule.UISchedule
                      extended by org.apache.myfaces.custom.schedule.AbstractHtmlSchedule
All Implemented Interfaces:
Serializable, javax.faces.component.ActionSource, javax.faces.component.StateHolder, javax.faces.component.ValueHolder, UserRoleAware

public abstract class AbstractHtmlSchedule
extends UISchedule
implements UserRoleAware, Serializable

A schedule component similar to the ones found in Outlook or Evolution

Renders a schedule component, showing appointments and events in a day, workweek, week or month view, similar to the schedule part of MS Outlook or Evolution.

The component is backed by an implementation of the ScheduleModel interface. Creating a custom model can be easily achieved by implementing this interface, or by overriding the AbstractScheduleModel class.

AbstractHtmlSchedule class holds all properties specific to the HTML version of the Schedule component.

Since:
1.1.7
Version:
$Revision: 691856 $
Author:
Bruno Aranda (latest modification by $Author: lu4242 $), Jurgen Lust
See Also:
Serialized Form

Field Summary
static String COMPONENT_FAMILY
           
static String COMPONENT_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
AbstractHtmlSchedule()
           
 
Method Summary
abstract  String getBackgroundClass()
           
abstract  String getColumnClass()
           
abstract  String getContentClass()
           
abstract  String getDateClass()
           
abstract  String getDayClass()
           
abstract  String getEntryClass()
           
abstract  Object getEntryRenderer()
           
abstract  String getEvenClass()
           
abstract  String getForegroundClass()
           
abstract  String getFreeClass()
           
abstract  String getGutterClass()
           
abstract  String getHeaderClass()
           
abstract  String getHolidayClass()
           
abstract  String getHoursClass()
           
abstract  String getInactiveDayClass()
           
abstract  String getMinutesClass()
           
abstract  String getMonthClass()
           
abstract  String getSelectedClass()
           
abstract  String getSelectedEntryClass()
           
abstract  String getSubtitleClass()
           
abstract  String getTextClass()
           
abstract  String getTitleClass()
           
abstract  String getUnevenClass()
           
abstract  String getWeekClass()
          the css class of the table representing a week in the compact mode (default: week)
 
Methods inherited from class org.apache.myfaces.custom.schedule.UISchedule
addActionListener, broadcast, findEntry, getAction, getActionListener, getActionListeners, getLastClickedDateAndTime, getMouseListener, getSubmittedEntry, queueEvent, removeActionListener, resetMouseEvents, restoreState, saveState, setAction, setActionListener, setLastClickedDateAndTime, setMouseListener, setSubmittedEntry
 
Methods inherited from class org.apache.myfaces.custom.schedule.UIScheduleBase
getCompactMonthDayOfWeekDateFormat, getCompactMonthRowHeight, getCompactWeekRowHeight, getConverter, getDetailedRowHeight, getFamily, 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 org.apache.myfaces.component.UserRoleAware
getEnabledOnUserRole, getVisibleOnUserRole, setEnabledOnUserRole, setVisibleOnUserRole
 
Methods inherited from interface javax.faces.component.ActionSource
isImmediate, setImmediate
 

Field Detail

COMPONENT_FAMILY

public static final String COMPONENT_FAMILY
See Also:
Constant Field Values

COMPONENT_TYPE

public static final String COMPONENT_TYPE
See Also:
Constant Field Values
Constructor Detail

AbstractHtmlSchedule

public AbstractHtmlSchedule()
Method Detail

getBackgroundClass

public abstract String getBackgroundClass()
Returns:
the backgroundClass

getColumnClass

public abstract String getColumnClass()
Returns:
the columnClass

getContentClass

public abstract String getContentClass()
Returns:
the contentClass

getDateClass

public abstract String getDateClass()
Returns:
the dateClass

getDayClass

public abstract String getDayClass()
Returns:
the dayClass

getEntryClass

public abstract String getEntryClass()
Returns:
the entryClass

getEntryRenderer

public abstract Object getEntryRenderer()
Returns:
the entryRenderer

getEvenClass

public abstract String getEvenClass()
Returns:
the evenClass

getForegroundClass

public abstract String getForegroundClass()
Returns:
the foregroundClass

getFreeClass

public abstract String getFreeClass()
Returns:
the freeClass

getGutterClass

public abstract String getGutterClass()
Returns:
the gutterClass

getHeaderClass

public abstract String getHeaderClass()
Returns:
the headerClass

getHolidayClass

public abstract String getHolidayClass()
Returns:
the holidayClass

getHoursClass

public abstract String getHoursClass()
Returns:
the hoursClass

getInactiveDayClass

public abstract String getInactiveDayClass()
Returns:
the inactiveDayClass

getMinutesClass

public abstract String getMinutesClass()
Returns:
the minutesClass

getMonthClass

public abstract String getMonthClass()
Returns:
the monthClass

getSelectedClass

public abstract String getSelectedClass()
Returns:
the selectedClass

getSelectedEntryClass

public abstract String getSelectedEntryClass()
Returns:
the selectedEntryClass

getSubtitleClass

public abstract String getSubtitleClass()
Returns:
the subtitleClass

getTextClass

public abstract String getTextClass()
Returns:
the textClass

getTitleClass

public abstract String getTitleClass()
Returns:
the titleClass

getUnevenClass

public abstract String getUnevenClass()
Returns:
the unevenClass

getWeekClass

public abstract String getWeekClass()
the css class of the table representing a week in the compact mode (default: week)

Returns:
the weekClass


Copyright © 2012 The Apache Software Foundation. All Rights Reserved.