org.apache.myfaces.custom.schedule
Class HtmlSchedule

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

All Implemented Interfaces:

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

public class HtmlSchedule

extends UISchedule

implements UserRoleAware, java.io.Serializable

Version:

$Revision: 392301 $

Author:

Bruno Aranda (latest modification by $Author: jlust $), Jurgen Lust

See Also:

Serialized Form

Field Summary

static java.lang.String	COMPONENT_FAMILY
static java.lang.String	COMPONENT_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

void	broadcast(javax.faces.event.FacesEvent event)
java.lang.String	getEnabledOnUserRole()
java.lang.String	getFamily()
java.util.Date	getLastClickedDateAndTime() The last date and time of day that was clicked.
javax.faces.el.MethodBinding	getMouseListener()
java.lang.String	getVisibleOnUserRole()
boolean	isSubmitOnClick() Should the parent form of this schedule be submitted when the user clicks on a day?
void	queueEvent(javax.faces.event.FacesEvent event)
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, java.lang.Object state)
java.lang.Object	saveState(javax.faces.context.FacesContext context)
void	setEnabledOnUserRole(java.lang.String enabledOnUserRole)
void	setLastClickedDateAndTime(java.util.Date lastClickedDateAndTime) The last date and time of day that was clicked.
void	setMouseListener(javax.faces.el.MethodBinding listener)
void	setSubmitOnClick(boolean submitOnClick) Should the parent form of this schedule be submitted when the user clicks on a day?
void	setVisibleOnUserRole(java.lang.String visibleOnUserRole)

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

addActionListener, findEntry, getAction, getActionListener, getActionListeners, getConverter, getLocalValue, getModel, getRendersChildren, getSubmittedEntry, getValue, getVisibleEndHour, getVisibleStartHour, getWorkingEndHour, getWorkingStartHour, isImmediate, isReadonly, removeActionListener, setAction, setActionListener, setConverter, setImmediate, setModel, setReadonly, setSubmittedEntry, setValue, setVisibleEndHour, setVisibleStartHour, setWorkingEndHour, setWorkingStartHour

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, 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

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

HtmlSchedule

public HtmlSchedule()

Method Detail

broadcast

public void broadcast(javax.faces.event.FacesEvent event)
               throws javax.faces.event.AbortProcessingException

Overrides:

broadcast in class UISchedule

Throws:

javax.faces.event.AbortProcessingException

See Also:

UIComponent.broadcast(javax.faces.event.FacesEvent)

getEnabledOnUserRole

public java.lang.String getEnabledOnUserRole()

Specified by:

getEnabledOnUserRole in interface UserRoleAware

See Also:

UserRoleAware.getEnabledOnUserRole()

getFamily

public java.lang.String getFamily()

Overrides:

getFamily in class UISchedule

See Also:

UIComponent.getFamily()

getLastClickedDateAndTime

public java.util.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

getVisibleOnUserRole

public java.lang.String getVisibleOnUserRole()

Specified by:

getVisibleOnUserRole in interface UserRoleAware

See Also:

UserRoleAware.getVisibleOnUserRole()

isSubmitOnClick

public boolean isSubmitOnClick()

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

queueEvent

public void queueEvent(javax.faces.event.FacesEvent event)

Overrides:

queueEvent in class UISchedule

See Also:

UIComponent.queueEvent(javax.faces.event.FacesEvent)

resetMouseEvents

public 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,
                         java.lang.Object state)

Specified by:

restoreState in interface javax.faces.component.StateHolder

Overrides:

restoreState in class UISchedule

See Also:

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

saveState

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

Specified by:

saveState in interface javax.faces.component.StateHolder

Overrides:

saveState in class UISchedule

See Also:

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

setEnabledOnUserRole

public void setEnabledOnUserRole(java.lang.String enabledOnUserRole)

Specified by:

setEnabledOnUserRole in interface UserRoleAware

See Also:

UserRoleAware.setEnabledOnUserRole(java.lang.String)

setLastClickedDateAndTime

public void setLastClickedDateAndTime(java.util.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.

Returns:

the last clicked date and time

setMouseListener

public void setMouseListener(javax.faces.el.MethodBinding listener)

Parameters:

listener - the method binding to the mouse listener method

setSubmitOnClick

public void setSubmitOnClick(boolean 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

setVisibleOnUserRole

public void setVisibleOnUserRole(java.lang.String visibleOnUserRole)

Specified by:

setVisibleOnUserRole in interface UserRoleAware