org.apache.myfaces.custom.schedule
Class UISchedule

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
All Implemented Interfaces:
Serializable, javax.faces.component.ActionSource, javax.faces.component.StateHolder, javax.faces.component.ValueHolder
Direct Known Subclasses:
AbstractHtmlSchedule

public class UISchedule
extends org.apache.myfaces.custom.schedule.UIScheduleBase
implements Serializable, javax.faces.component.ActionSource

This class contains all 'interactive' stuff for the Schedule component, meaning actions and actionListeners.

Version:
$Revision$
Author:
Jurgen Lust
See Also:
Serialized Form

Field Summary
static String COMPONENT_TYPE
           
 
Fields inherited from class org.apache.myfaces.custom.schedule.UIScheduleBase
COMPONENT_FAMILY
 
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
 
Constructor Summary
UISchedule()
           
 
Method Summary
 void addActionListener(javax.faces.event.ActionListener listener)
           
 void broadcast(javax.faces.event.FacesEvent event)
           
protected  ScheduleEntry findEntry(String id)
          Find the entry with the given id
 javax.faces.el.MethodBinding getAction()
           
 javax.faces.el.MethodBinding getActionListener()
           
 javax.faces.event.ActionListener[] getActionListeners()
           
 Date getLastClickedDateAndTime()
          The last date and time of day that was clicked.
 javax.faces.el.MethodBinding getMouseListener()
           
 ScheduleEntry getSubmittedEntry()
           
 void queueEvent(javax.faces.event.FacesEvent event)
           
 void removeActionListener(javax.faces.event.ActionListener listener)
           
protected  void resetMouseEvents()
          This method is invoked at the beginning of the restore view phase, resetting all mouse event variables that were left from the previous request
 void restoreState(javax.faces.context.FacesContext context, Object state)
           
 Object saveState(javax.faces.context.FacesContext context)
           
 void setAction(javax.faces.el.MethodBinding action)
           
 void setActionListener(javax.faces.el.MethodBinding actionListener)
           
protected  void setLastClickedDateAndTime(Date lastClickedDateAndTime)
          The last date and time of day that was clicked.
 void setMouseListener(javax.faces.el.MethodBinding listener)
           
protected  void setSubmittedEntry(ScheduleEntry submittedEntry)
           
 
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 javax.faces.component.ActionSource
isImmediate, setImmediate
 

Field Detail

COMPONENT_TYPE

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

UISchedule

public UISchedule()
Method Detail

addActionListener

public void addActionListener(javax.faces.event.ActionListener listener)
Specified by:
addActionListener in interface javax.faces.component.ActionSource

broadcast

public void broadcast(javax.faces.event.FacesEvent event)
               throws javax.faces.event.AbortProcessingException
Overrides:
broadcast in class javax.faces.component.UIComponentBase
Throws:
javax.faces.event.AbortProcessingException
See Also:
UIComponent.broadcast(javax.faces.event.FacesEvent)

findEntry

protected ScheduleEntry findEntry(String id)
Find the entry with the given id

Parameters:
id - the id
Returns:
the entry

getAction

public javax.faces.el.MethodBinding getAction()
Specified by:
getAction in interface javax.faces.component.ActionSource

getActionListener

public javax.faces.el.MethodBinding getActionListener()
Specified by:
getActionListener in interface javax.faces.component.ActionSource

getActionListeners

public javax.faces.event.ActionListener[] getActionListeners()
Specified by:
getActionListeners in interface javax.faces.component.ActionSource

getLastClickedDateAndTime

public Date getLastClickedDateAndTime()
The last date and time of day that was clicked. This is set when submitOnClick is true, and the schedule is clicked by the user.

Returns:
the last clicked date and time

getMouseListener

public javax.faces.el.MethodBinding getMouseListener()
Returns:
the method binding to the mouse listener method

getSubmittedEntry

public ScheduleEntry getSubmittedEntry()
Returns:
the submittedEntry

queueEvent

public void queueEvent(javax.faces.event.FacesEvent event)
Overrides:
queueEvent in class javax.faces.component.UIComponentBase
See Also:
UIComponent.queueEvent(javax.faces.event.FacesEvent)

removeActionListener

public void removeActionListener(javax.faces.event.ActionListener listener)
Specified by:
removeActionListener in interface javax.faces.component.ActionSource

resetMouseEvents

protected void resetMouseEvents()
This method is invoked at the beginning of the restore view phase, resetting all mouse event variables that were left from the previous request


restoreState

public void restoreState(javax.faces.context.FacesContext context,
                         Object state)
Specified by:
restoreState in interface javax.faces.component.StateHolder
Overrides:
restoreState in class org.apache.myfaces.custom.schedule.UIScheduleBase
See Also:
UIScheduleBase.restoreState(javax.faces.context.FacesContext, java.lang.Object)

saveState

public Object saveState(javax.faces.context.FacesContext context)
Specified by:
saveState in interface javax.faces.component.StateHolder
Overrides:
saveState in class org.apache.myfaces.custom.schedule.UIScheduleBase
See Also:
UIScheduleBase.saveState(javax.faces.context.FacesContext)

setAction

public void setAction(javax.faces.el.MethodBinding action)
Specified by:
setAction in interface javax.faces.component.ActionSource

setActionListener

public void setActionListener(javax.faces.el.MethodBinding actionListener)
Specified by:
setActionListener in interface javax.faces.component.ActionSource

setLastClickedDateAndTime

protected void setLastClickedDateAndTime(Date lastClickedDateAndTime)
The last date and time of day that was clicked. This is set when submitOnClick is true, and the schedule is clicked by the user.


setMouseListener

public void setMouseListener(javax.faces.el.MethodBinding listener)
Parameters:
listener - the method binding to the mouse listener method

setSubmittedEntry

protected void setSubmittedEntry(ScheduleEntry submittedEntry)
Parameters:
submittedEntry - the submittedEntry to set


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