org.apache.myfaces.custom.date
Class HtmlInputDate

java.lang.Object
  javax.faces.component.UIComponent
      javax.faces.component.UIComponentBase
          javax.faces.component.UIOutput
              javax.faces.component.UIInput
                  javax.faces.component.html.HtmlInputText
                      org.apache.myfaces.custom.date.AbstractHtmlInputDate
                          org.apache.myfaces.custom.date.HtmlInputDate

All Implemented Interfaces:

java.util.EventListener, javax.faces.component.behavior.ClientBehaviorHolder, javax.faces.component.EditableValueHolder, javax.faces.component.PartialStateHolder, javax.faces.component.StateHolder, javax.faces.component.ValueHolder, javax.faces.event.ComponentSystemEventListener, javax.faces.event.FacesListener, javax.faces.event.SystemEventListenerHolder, AlignProperty, ForceIdAware, UserRoleAware

public class HtmlInputDate
extends AbstractHtmlInputDate

Nested Class Summary

protected static class

HtmlInputDate.PropertyKeys

Nested classes/interfaces inherited from class org.apache.myfaces.custom.date.AbstractHtmlInputDate

AbstractHtmlInputDate.UserData

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 javax.faces.component.UIInput

CONVERSION_MESSAGE_ID, REQUIRED_MESSAGE_ID, UPDATE_MESSAGE_ID, VALIDATE_EMPTY_FIELDS_PARAM_NAME

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

HtmlInputDate()

Method Summary

java.lang.String	getAlign() HTML: Specifies the horizontal alignment of this element.
DateBusinessConverter	getDateBusinessConverter() Indicate an object used as a bridge between the java.util.Date instance used by this component internally and the value object used on the bean, referred as a "business" value.
java.lang.String	getEmptyAmpmSelection() Label to be used when displaying an empty ampm selection
java.lang.String	getEmptyMonthSelection() Label to be used when displaying an empty month selection
java.lang.String	getEnabledOnUserRole() If user is in given role, this component will be rendered normally.
java.lang.String	getFamily()
java.lang.String	getTimeZone()
java.lang.String	getType() Specifies the type of value to be accepted.
java.lang.String	getVisibleOnUserRole() If user is in given role, this component will be rendered normally.
boolean	isAmpm() If true, use 12hr times with AM/PM selector; if false, use 24hr time.
boolean	isDisabled() HTML: When true, this element cannot receive focus.
boolean	isForceId() If true, this component will force the use of the specified id when rendering.
boolean	isForceIdIndex() If false, this component will not append a '[n]' suffix (where 'n' is the row index) to components that are contained within a "list." This value will be true by default and the value will be ignored if the value of forceId is false (or not specified.)
boolean	isPopupCalendar()
boolean	isReadonly() HTML: When true, indicates that this component cannot be modified by the user.
void	setAlign(java.lang.String align)
void	setAmpm(boolean ampm)
void	setDateBusinessConverter(DateBusinessConverter dateBusinessConverter)
void	setDisabled(boolean disabled)
void	setEmptyAmpmSelection(java.lang.String emptyAmpmSelection)
void	setEmptyMonthSelection(java.lang.String emptyMonthSelection)
void	setEnabledOnUserRole(java.lang.String enabledOnUserRole)
void	setForceId(boolean forceId)
void	setForceIdIndex(boolean forceIdIndex)
void	setPopupCalendar(boolean popupCalendar)
void	setReadonly(boolean readonly)
void	setTimeZone(java.lang.String timeZone)
void	setType(java.lang.String type)
void	setVisibleOnUserRole(java.lang.String visibleOnUserRole)

Methods inherited from class org.apache.myfaces.custom.date.AbstractHtmlInputDate

getClientId, getConverter, getUserData, isRendered

Methods inherited from class javax.faces.component.html.HtmlInputText

getAccesskey, getAlt, getAutocomplete, getDefaultEventName, getDir, getEventNames, getLabel, getLang, getMaxlength, getOnblur, getOnchange, getOnclick, getOndblclick, getOnfocus, getOnkeydown, getOnkeypress, getOnkeyup, getOnmousedown, getOnmousemove, getOnmouseout, getOnmouseover, getOnmouseup, getOnselect, getSize, getStyle, getStyleClass, getTabindex, getTitle, setAccesskey, setAlt, setAutocomplete, setDir, setLabel, setLang, setMaxlength, setOnblur, setOnchange, setOnclick, setOndblclick, setOnfocus, setOnkeydown, setOnkeypress, setOnkeyup, setOnmousedown, setOnmousemove, setOnmouseout, setOnmouseover, setOnmouseup, setOnselect, setSize, setStyle, setStyleClass, setTabindex, setTitle

Methods inherited from class javax.faces.component.UIInput

addValidator, addValueChangeListener, broadcast, clearInitialState, compareValues, decode, getConvertedValue, getConverterMessage, getRequiredMessage, getSubmittedValue, getValidator, getValidatorMessage, getValidators, getValue, getValueChangeListener, getValueChangeListeners, isEmpty, isImmediate, isLocalValueSet, isRequired, isValid, markInitialState, processDecodes, processUpdates, processValidators, removeValidator, removeValueChangeListener, resetValue, restoreState, saveState, setConverterMessage, setImmediate, setLocalValueSet, setRequired, setRequiredMessage, setSubmittedValue, setValid, setValidator, setValidatorMessage, setValue, setValueChangeListener, updateModel, validate, validateValue

Methods inherited from class javax.faces.component.UIOutput

getLocalValue, setConverter

Methods inherited from class javax.faces.component.UIComponentBase

addClientBehavior, addFacesListener, encodeBegin, encodeChildren, encodeEnd, findComponent, getAttributes, getChildCount, getChildren, getClientBehaviors, getFacesContext, getFacesListeners, getFacet, getFacetCount, getFacets, getFacetsAndChildren, getId, getParent, getRenderer, getRendererType, getRendersChildren, getValueBinding, initialStateMarked, invokeOnComponent, isTransient, processRestoreState, processSaveState, queueEvent, 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 javax.faces.component.behavior.ClientBehaviorHolder

addClientBehavior, getClientBehaviors

Methods inherited from interface javax.faces.component.ValueHolder

getLocalValue, setConverter

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

HtmlInputDate

public HtmlInputDate()

Method Detail

getFamily

public java.lang.String getFamily()

Overrides:

getFamily in class javax.faces.component.html.HtmlInputText

getDateBusinessConverter

public DateBusinessConverter getDateBusinessConverter()

Description copied from class: AbstractHtmlInputDate

Indicate an object used as a bridge between the java.util.Date instance used by this component internally and the value object used on the bean, referred as a "business" value.

• If the value is literal, look for the mentioned class instance, create a new instance and assign to the component property.
• If it the value a EL Expression, set the expression to the component property.

Specified by:

getDateBusinessConverter in class AbstractHtmlInputDate

setDateBusinessConverter

public void setDateBusinessConverter(DateBusinessConverter dateBusinessConverter)

Specified by:

setDateBusinessConverter in class AbstractHtmlInputDate

getTimeZone

public java.lang.String getTimeZone()

Specified by:

getTimeZone in class AbstractHtmlInputDate

setTimeZone

public void setTimeZone(java.lang.String timeZone)

getType

public java.lang.String getType()

Description copied from class: AbstractHtmlInputDate

Specifies the type of value to be accepted. Valid values are: date | time | short_time | both | full

Specified by:

getType in class AbstractHtmlInputDate

setType

public void setType(java.lang.String type)

isAmpm

public boolean isAmpm()

Description copied from class: AbstractHtmlInputDate

If true, use 12hr times with AM/PM selector; if false, use 24hr time. Default false.

Specified by:

isAmpm in class AbstractHtmlInputDate

setAmpm

public void setAmpm(boolean ampm)

isPopupCalendar

public boolean isPopupCalendar()

Specified by:

isPopupCalendar in class AbstractHtmlInputDate

setPopupCalendar

public void setPopupCalendar(boolean popupCalendar)

getEmptyMonthSelection

public java.lang.String getEmptyMonthSelection()

Description copied from class: AbstractHtmlInputDate

Label to be used when displaying an empty month selection

Specified by:

getEmptyMonthSelection in class AbstractHtmlInputDate

setEmptyMonthSelection

public void setEmptyMonthSelection(java.lang.String emptyMonthSelection)

getEmptyAmpmSelection

public java.lang.String getEmptyAmpmSelection()

Description copied from class: AbstractHtmlInputDate

Label to be used when displaying an empty ampm selection

Specified by:

getEmptyAmpmSelection in class AbstractHtmlInputDate

setEmptyAmpmSelection

public void setEmptyAmpmSelection(java.lang.String emptyAmpmSelection)

isReadonly

public boolean isReadonly()

Description copied from class: AbstractHtmlInputDate

HTML: When true, indicates that this component cannot be modified by the user. The element may receive focus unless it has also been disabled.

Specified by:

isReadonly in class AbstractHtmlInputDate

setReadonly

public void setReadonly(boolean readonly)

Overrides:

setReadonly in class javax.faces.component.html.HtmlInputText

isDisabled

public boolean isDisabled()

Description copied from class: AbstractHtmlInputDate

HTML: When true, this element cannot receive focus.

Specified by:

isDisabled in class AbstractHtmlInputDate

setDisabled

public void setDisabled(boolean disabled)

Overrides:

setDisabled in class javax.faces.component.html.HtmlInputText

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.

Returns:

setEnabledOnUserRole

public void setEnabledOnUserRole(java.lang.String enabledOnUserRole)

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.

Returns:

setVisibleOnUserRole

public void setVisibleOnUserRole(java.lang.String visibleOnUserRole)

isForceId

public boolean isForceId()

Description copied from interface: ForceIdAware

If true, this component will force the use of the specified id when rendering.

Returns:

setForceId

public void setForceId(boolean forceId)

isForceIdIndex

public boolean isForceIdIndex()

Description copied from interface: ForceIdAware

If false, this component will not append a '[n]' suffix (where 'n' is the row index) to components that are contained within a "list." This value will be true by default and the value will be ignored if the value of forceId is false (or not specified.)

Returns:

setForceIdIndex

public void setForceIdIndex(boolean forceIdIndex)

getAlign

public java.lang.String getAlign()

Description copied from interface: AlignProperty

HTML: Specifies the horizontal alignment of this element. Deprecated in HTML 4.01.

setAlign

public void setAlign(java.lang.String align)