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:
java.io.Serializable, java.util.EventListener, javax.faces.component.ActionSource, javax.faces.component.ActionSource2, javax.faces.component.PartialStateHolder, javax.faces.component.StateHolder, javax.faces.component.ValueHolder, javax.faces.event.ComponentSystemEventListener, javax.faces.event.FacesListener, javax.faces.event.SystemEventListenerHolder, UserRoleAware
Direct Known Subclasses:
HtmlSchedule

public abstract class AbstractHtmlSchedule
extends UISchedule
implements UserRoleAware, java.io.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

Nested Class Summary
 
Nested classes/interfaces inherited from class org.apache.myfaces.custom.schedule.UISchedule
UISchedule.PropertyKeys
 
Field Summary
static java.lang.String COMPONENT_FAMILY
           
static java.lang.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 class javax.faces.component.UIComponent
BEANINFO_KEY, bindings, COMPOSITE_COMPONENT_TYPE_KEY, COMPOSITE_FACET_NAME, CURRENT_COMPONENT, CURRENT_COMPOSITE_COMPONENT, FACETS_KEY, VIEW_LOCATION_KEY
 
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  java.lang.String getBackgroundClass()
           
abstract  java.lang.String getColumnClass()
           
abstract  java.lang.String getContentClass()
           
abstract  java.lang.String getDateClass()
           
abstract  java.lang.String getDayClass()
           
abstract  java.lang.String getEntryClass()
           
abstract  java.lang.Object getEntryRenderer()
           
abstract  java.lang.String getEvenClass()
           
abstract  java.lang.String getForegroundClass()
           
abstract  java.lang.String getFreeClass()
           
abstract  java.lang.String getGutterClass()
           
abstract  java.lang.String getHeaderClass()
           
abstract  java.lang.String getHolidayClass()
           
abstract  java.lang.String getHoursClass()
           
abstract  java.lang.String getInactiveDayClass()
           
abstract  java.lang.String getMinutesClass()
           
abstract  java.lang.String getMonthClass()
           
abstract  java.lang.String getSelectedClass()
           
abstract  java.lang.String getSelectedEntryClass()
           
abstract  java.lang.String getSubtitleClass()
           
abstract  java.lang.String getTextClass()
           
abstract  java.lang.String getTitleClass()
           
abstract  java.lang.String getUnevenClass()
           
abstract  java.lang.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, getActionExpression, getActionListener, getActionListeners, getLastClickedDateAndTime, getMouseListener, getMouseListenerExpression, getSubmittedEntry, queueEvent, removeActionListener, resetMouseEvents, restoreState, saveState, setAction, setActionExpression, setActionListener, setLastClickedDateAndTime, setMouseListener, setMouseListenerExpression, 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
addClientBehavior, addFacesListener, clearInitialState, decode, encodeBegin, encodeChildren, encodeEnd, findComponent, getAttributes, getChildCount, getChildren, getClientBehaviors, getClientId, getDefaultEventName, getEventNames, getFacesContext, getFacesListeners, getFacet, getFacetCount, getFacets, getFacetsAndChildren, getId, getParent, getRenderer, getRendererType, getRendersChildren, getValueBinding, initialStateMarked, invokeOnComponent, isRendered, isTransient, markInitialState, processDecodes, processRestoreState, processSaveState, processUpdates, processValidators, removeFacesListener, restoreAttachedState, saveAttachedState, setId, setParent, setRendered, setRendererType, setTransient, setValueBinding, visitTree
 
Methods inherited from class javax.faces.component.UIComponent
encodeAll, getClientId, getCompositeComponentParent, getContainerClientId, getCurrentComponent, getCurrentCompositeComponent, getListenersForEventClass, getNamingContainer, getResourceBundleMap, getStateHelper, getStateHelper, getValueExpression, isCompositeComponent, isInView, isVisitable, popComponentFromEL, processEvent, pushComponentToEL, setInView, setValueExpression, subscribeToEvent, unsubscribeFromEvent
 
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 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
Constructor Detail

AbstractHtmlSchedule

public AbstractHtmlSchedule()
Method Detail

getBackgroundClass

public abstract java.lang.String getBackgroundClass()
Returns:
the backgroundClass

getColumnClass

public abstract java.lang.String getColumnClass()
Returns:
the columnClass

getContentClass

public abstract java.lang.String getContentClass()
Returns:
the contentClass

getDateClass

public abstract java.lang.String getDateClass()
Returns:
the dateClass

getDayClass

public abstract java.lang.String getDayClass()
Returns:
the dayClass

getEntryClass

public abstract java.lang.String getEntryClass()
Returns:
the entryClass

getEntryRenderer

public abstract java.lang.Object getEntryRenderer()
Returns:
the entryRenderer

getEvenClass

public abstract java.lang.String getEvenClass()
Returns:
the evenClass

getForegroundClass

public abstract java.lang.String getForegroundClass()
Returns:
the foregroundClass

getFreeClass

public abstract java.lang.String getFreeClass()
Returns:
the freeClass

getGutterClass

public abstract java.lang.String getGutterClass()
Returns:
the gutterClass

getHeaderClass

public abstract java.lang.String getHeaderClass()
Returns:
the headerClass

getHolidayClass

public abstract java.lang.String getHolidayClass()
Returns:
the holidayClass

getHoursClass

public abstract java.lang.String getHoursClass()
Returns:
the hoursClass

getInactiveDayClass

public abstract java.lang.String getInactiveDayClass()
Returns:
the inactiveDayClass

getMinutesClass

public abstract java.lang.String getMinutesClass()
Returns:
the minutesClass

getMonthClass

public abstract java.lang.String getMonthClass()
Returns:
the monthClass

getSelectedClass

public abstract java.lang.String getSelectedClass()
Returns:
the selectedClass

getSelectedEntryClass

public abstract java.lang.String getSelectedEntryClass()
Returns:
the selectedEntryClass

getSubtitleClass

public abstract java.lang.String getSubtitleClass()
Returns:
the subtitleClass

getTextClass

public abstract java.lang.String getTextClass()
Returns:
the textClass

getTitleClass

public abstract java.lang.String getTitleClass()
Returns:
the titleClass

getUnevenClass

public abstract java.lang.String getUnevenClass()
Returns:
the unevenClass

getWeekClass

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

Returns:
the weekClass


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