|
ICEfaces ICE Components 3.3.0 Java API Documentation |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectjavax.faces.component.UIComponent
javax.faces.component.UIComponentBase
javax.faces.component.UIOutput
javax.faces.component.UIInput
javax.faces.component.html.HtmlInputText
com.icesoft.faces.component.ext.HtmlInputText
com.icesoft.faces.component.selectinputdate.SelectInputDate
public class SelectInputDate
SelectInputDate is a JSF component class that represents an ICEfaces input date selector.
The component extends the ICEfaces extended HTMLPanelGroup. By default the component is rendered by the "com.icesoft.faces.Calendar" renderer type.
Nested Class Summary |
---|
Nested classes/interfaces inherited from class javax.faces.component.html.HtmlInputText |
---|
javax.faces.component.html.HtmlInputText.PropertyKeys |
Field Summary | |
---|---|
static java.lang.String |
CALENDAR_INPUTTEXT
|
static java.lang.String |
COMPONENT_FAMILY
The component family. |
static java.lang.String |
COMPONENT_TYPE
The component type. |
static java.lang.String |
DEFAULT_POPUP_DATE_FORMAT
The default date format for the popup input text child component. |
Fields inherited from class com.icesoft.faces.component.ext.HtmlInputText |
---|
focus, partialSubmit, 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 |
---|
ATTRS_WITH_DECLARED_DEFAULT_VALUES, BEANINFO_KEY, bindings, COMPOSITE_COMPONENT_TYPE_KEY, COMPOSITE_FACET_NAME, CURRENT_COMPONENT, CURRENT_COMPOSITE_COMPONENT, FACETS_KEY, HONOR_CURRENT_COMPONENT_ATTRIBUTES_PARAM_NAME, VIEW_LOCATION_KEY |
Fields inherited from interface com.icesoft.faces.component.IceExtended |
---|
ENABLED_ON_USER_ROLE_ATTR, RENDERED_ON_USER_ROLE_ATTR |
Constructor Summary | |
---|---|
SelectInputDate()
Creates an instance and sets renderer type to "com.icesoft.faces.Calendar". |
Method Summary | |
---|---|
void |
encodeBegin(javax.faces.context.FacesContext context)
|
java.lang.String |
formatDate(java.util.Date date)
Formats the given date using the default date format MM/dd/yyyy. |
java.lang.String |
getCalendarInputClass()
|
java.lang.String |
getClosePopupClass()
Returns the style class name applied to the close popup button in the SelectInputDate calendar. |
java.lang.String |
getClosePopupImage()
Returns the name of the close popup image. |
java.lang.String |
getCurrentDayCellClass()
Returns the currentDayCell style class name. |
java.lang.String |
getDayCellClass()
Returns the style class name applied to the day cells in the SelectInputDate calendar. |
java.lang.String |
getFamily()
|
java.lang.String |
getHighlightClass()
Return the value of the highlightClass property. |
java.lang.String |
getHighlightUnit()
Return the value of the highlightUnit property. |
java.lang.String |
getHighlightValue()
Return the value of the highlightValue property. |
java.lang.String |
getImageDir()
|
java.lang.String |
getInputTitle()
|
java.util.Map |
getLinkMap()
|
java.lang.String |
getMonthYearDropdownClass()
|
java.lang.String |
getMonthYearRowClass()
Returns the style class name used for the row containing the month and Year. |
java.lang.String |
getMoveNextClass()
Returns the style class name applied to the next month or year button in the SelectInputDate calendar. |
java.lang.String |
getMoveNextImage()
|
java.lang.String |
getMovePrevClass()
Returns the style class name applied to the previous month or year button in the SelectInputDate calendar. |
java.lang.String |
getMovePreviousImage()
Returns the name of the move previous image. |
java.util.Date |
getNavDate()
Get the navDate to render a calendar on a navigation event. |
java.lang.String |
getOpenPopupClass()
Returns the style class name applied to the open popup button in the SelectInputDate calendar. |
java.lang.String |
getOpenPopupImage()
returns the name of the open popup image. |
boolean |
getPartialSubmit()
Return the value of the partialSubmit property. |
java.lang.String |
getPopupDateFormat()
Returns the date format string of the input text child componenet. |
java.lang.String |
getSelectedDayLink()
|
protected java.lang.String |
getSpecifiedPopupDateFormat()
If the popupDateFormat was specified, then return that, but not any default values. |
java.lang.String |
getStyle()
CSS style attribute. |
java.lang.String |
getStyleClass()
Return the value of the styleClass property. |
java.lang.String |
getTextToRender()
|
java.lang.String |
getTimeClass()
|
java.lang.String |
getTimeDropDownClass()
|
java.lang.String |
getWeekRowClass()
Returns the style class name of the weekRowClass The style class is defined in an external style sheet. |
boolean |
isImageDirSet()
|
boolean |
isNavEvent()
A navEvent value of true indicates that a navEvent has occured. |
boolean |
isRenderAsPopup()
|
boolean |
isRenderMonthAsDropdown()
|
boolean |
isRenderWeekNumbers()
|
boolean |
isRenderYearAsDropdown()
|
boolean |
isShowPopup()
A showPopup value of true indicates the SelectInputText popup be rendered. |
void |
requestFocus()
This method is used to communicate a focus request from the application to the client browser. |
javax.faces.convert.DateTimeConverter |
resolveDateTimeConverter(javax.faces.context.FacesContext context)
To properly function, selectInputDate needs to use the same timezone in the inputText field as well as the calendar, which is accomplished by using a javax.faces.convert.DateTimeConverter, which provides the required Converter behaviours, as we as gives access to its TimeZone object. |
java.util.Locale |
resolveLocale(javax.faces.context.FacesContext context)
|
java.util.TimeZone |
resolveTimeZone(javax.faces.context.FacesContext context)
|
void |
restoreSeriesState(javax.faces.context.FacesContext facesContext,
java.lang.Object state)
|
void |
restoreState(javax.faces.context.FacesContext context,
java.lang.Object state)
Perform any processing required to restore the state from the entries in the state Object. |
java.lang.Object |
saveSeriesState(javax.faces.context.FacesContext facesContext)
|
java.lang.Object |
saveState(javax.faces.context.FacesContext context)
Gets the state of the instance as a Serializable
Object. |
void |
setHighlightClass(java.lang.String highlightClass)
Set the value of the highlightClass property. |
void |
setHighlightUnit(java.lang.String highlightUnit)
Set the value of the highlightUnit property. |
void |
setHighlightValue(java.lang.String highlightValue)
Set the value of the highlightValue property. |
void |
setImageDir(java.lang.String imageDir)
Sets the directory where the images used by this component are located. |
void |
setInputTitle(java.lang.String inputTitle)
|
void |
setLinkMap(java.util.Map linkMap)
|
void |
setNavDate(java.util.Date navDate)
Set the date value of the navDate. |
void |
setNavEvent(boolean navEvent)
Sets the boolean navEvent attribute. |
void |
setPopupDateFormat(java.lang.String popupDateFormat)
Sets the date format of the input text child component when the component is in popup mode. |
void |
setRenderAsPopup(boolean b)
|
void |
setRenderMonthAsDropdown(boolean b)
|
void |
setRenderWeekNumbers(boolean b)
|
void |
setRenderYearAsDropdown(boolean b)
|
void |
setSelectedDayLink(java.lang.String selectedDayLink)
|
void |
setShowPopup(boolean showPopup)
Setting the showPopup attribute to true will render the SelectInputDate popup calendar. |
void |
setStyle(java.lang.String style)
CSS style attribute. |
void |
setStyleClass(java.lang.String styleClass)
Set the value of the styleClass property. |
void |
validate(javax.faces.context.FacesContext context)
|
Methods inherited from class javax.faces.component.html.HtmlInputText |
---|
getAccesskey, getAlt, getDefaultEventName, getDir, getEventNames, getLabel, getLang, getMaxlength, getOnblur, getOnchange, getOnclick, getOndblclick, getOnfocus, getOnkeydown, getOnkeypress, getOnkeyup, getOnmousedown, getOnmousemove, getOnmouseout, getOnmouseover, getOnmouseup, getOnselect, getSize, getTabindex, getTitle, isReadonly, setAccesskey, setAlt, setDir, setDisabled, setLabel, setLang, setMaxlength, setOnblur, setOnchange, setOnclick, setOndblclick, setOnfocus, setOnkeydown, setOnkeypress, setOnkeyup, setOnmousedown, setOnmousemove, setOnmouseout, setOnmouseover, setOnmouseup, setOnselect, setReadonly, setSize, setTabindex, setTitle |
Methods inherited from class javax.faces.component.UIInput |
---|
addValidator, addValueChangeListener, clearInitialState, compareValues, getConvertedValue, getConverterMessage, getRequiredMessage, getSubmittedValue, getValidator, getValidatorMessage, getValidators, getValueChangeListener, getValueChangeListeners, isEmpty, isLocalValueSet, isRequired, isValid, markInitialState, processDecodes, processUpdates, processValidators, removeValidator, removeValueChangeListener, resetValue, setConverterMessage, setLocalValueSet, setRequired, setRequiredMessage, setSubmittedValue, setValid, setValidator, setValidatorMessage, setValue, setValueChangeListener, updateModel, validateValue |
Methods inherited from class javax.faces.component.UIOutput |
---|
getConverter, getLocalValue, getValue, setConverter |
Methods inherited from class javax.faces.component.UIComponentBase |
---|
addClientBehavior, addFacesListener, encodeChildren, encodeEnd, findComponent, getAttributes, getChildCount, getChildren, getClientBehaviors, getClientId, getFacesContext, getFacesListeners, getFacet, getFacetCount, getFacets, getFacetsAndChildren, getId, getListenersForEventClass, getParent, getRenderer, getRendererType, getRendersChildren, getValueBinding, invokeOnComponent, isTransient, processRestoreState, processSaveState, removeFacesListener, restoreAttachedState, saveAttachedState, setId, setParent, setRendered, setRendererType, setTransient, subscribeToEvent, unsubscribeFromEvent |
Methods inherited from class javax.faces.component.UIComponent |
---|
encodeAll, getClientId, getCompositeComponentParent, getContainerClientId, getCurrentComponent, getCurrentCompositeComponent, getNamingContainer, getResourceBundleMap, getStateHelper, getStateHelper, getTransientStateHelper, getTransientStateHelper, getValueExpression, initialStateMarked, isCompositeComponent, isInView, isVisitable, popComponentFromEL, processEvent, pushComponentToEL, restoreTransientState, saveTransientState, setInView, setValueExpression, visitTree |
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 |
---|
getConverter, getLocalValue, getValue, setConverter |
Field Detail |
---|
public static final java.lang.String COMPONENT_TYPE
public static final java.lang.String COMPONENT_FAMILY
public static final java.lang.String DEFAULT_POPUP_DATE_FORMAT
public static final java.lang.String CALENDAR_INPUTTEXT
Constructor Detail |
---|
public SelectInputDate()
Method Detail |
---|
public void encodeBegin(javax.faces.context.FacesContext context) throws java.io.IOException
encodeBegin
in class javax.faces.component.UIComponentBase
java.io.IOException
public java.lang.String getStyle()
getStyle
in class javax.faces.component.html.HtmlInputText
public void setStyle(java.lang.String style)
setStyle
in class javax.faces.component.html.HtmlInputText
style
- getStyle()
public java.lang.String formatDate(java.util.Date date)
date
-
public java.lang.String getTextToRender()
public javax.faces.convert.DateTimeConverter resolveDateTimeConverter(javax.faces.context.FacesContext context)
public java.util.TimeZone resolveTimeZone(javax.faces.context.FacesContext context)
public java.util.Locale resolveLocale(javax.faces.context.FacesContext context)
public void setNavEvent(boolean navEvent)
navEvent
- a value of true indicates that a navigation event has
occured.public boolean isNavEvent()
public void setNavDate(java.util.Date navDate)
navDate
- a Date assigned to the navDate.public java.util.Date getNavDate()
public void setShowPopup(boolean showPopup)
showPopup
- a value of true will cause the popup calendar to be
renderedpublic boolean isShowPopup()
public java.lang.String getFamily()
getFamily
in class javax.faces.component.UIInput
public java.lang.String getMonthYearRowClass()
public java.lang.String getMonthYearDropdownClass()
public java.lang.String getTimeClass()
public java.lang.String getTimeDropDownClass()
public java.lang.String getWeekRowClass()
public java.lang.String getCalendarInputClass()
public java.lang.String getDayCellClass()
public java.lang.String getMovePrevClass()
public java.lang.String getMoveNextClass()
public java.lang.String getOpenPopupClass()
public java.lang.String getClosePopupClass()
public void setStyleClass(java.lang.String styleClass)
HtmlInputText
Set the value of the styleClass
property.
setStyleClass
in class HtmlInputText
public java.lang.String getStyleClass()
Return the value of the styleClass
property.
getStyleClass
in class HtmlInputText
public java.lang.String getCurrentDayCellClass()
public boolean isRenderAsPopup()
public void setRenderAsPopup(boolean b)
b
- public boolean isRenderMonthAsDropdown()
public void setRenderMonthAsDropdown(boolean b)
public boolean isRenderYearAsDropdown()
public void setRenderYearAsDropdown(boolean b)
public boolean isRenderWeekNumbers()
public void setRenderWeekNumbers(boolean b)
public void setImageDir(java.lang.String imageDir)
imageDir
- the directory where the images used by this component are
locatedpublic java.lang.String getImageDir()
public boolean isImageDirSet()
public java.lang.String getMoveNextImage()
public java.lang.String getMovePreviousImage()
public java.lang.String getOpenPopupImage()
public java.lang.String getClosePopupImage()
public void setPopupDateFormat(java.lang.String popupDateFormat)
popupDateFormat
- public java.lang.String getPopupDateFormat()
protected java.lang.String getSpecifiedPopupDateFormat()
public java.lang.Object saveState(javax.faces.context.FacesContext context)
HtmlInputText
Gets the state of the instance as a Serializable
Object.
saveState
in interface javax.faces.component.StateHolder
saveState
in class HtmlInputText
public void restoreState(javax.faces.context.FacesContext context, java.lang.Object state)
HtmlInputText
Perform any processing required to restore the state from the entries in the state Object.
restoreState
in interface javax.faces.component.StateHolder
restoreState
in class HtmlInputText
public java.lang.Object saveSeriesState(javax.faces.context.FacesContext facesContext)
saveSeriesState
in interface org.icefaces.impl.component.SeriesStateHolder
public void restoreSeriesState(javax.faces.context.FacesContext facesContext, java.lang.Object state)
restoreSeriesState
in interface org.icefaces.impl.component.SeriesStateHolder
public java.util.Map getLinkMap()
public void setLinkMap(java.util.Map linkMap)
linkMap
- public java.lang.String getSelectedDayLink()
public void setSelectedDayLink(java.lang.String selectedDayLink)
selectedDayLink
- public boolean getPartialSubmit()
HtmlInputText
Return the value of the partialSubmit
property.
getPartialSubmit
in interface com.icesoft.faces.component.IceExtended
getPartialSubmit
in class HtmlInputText
public void setHighlightClass(java.lang.String highlightClass)
Set the value of the highlightClass
property.
highlightClass
- public java.lang.String getHighlightClass()
Return the value of the highlightClass
property.
public void requestFocus()
HtmlInputText
requestFocus
in class HtmlInputText
public void setHighlightUnit(java.lang.String highlightUnit)
Set the value of the highlightUnit
property.
highlightUnit
- The highlight classpublic java.lang.String getHighlightUnit()
Return the value of the highlightUnit
property.
public void setHighlightValue(java.lang.String highlightValue)
Set the value of the highlightValue
property.
highlightValue
- public java.lang.String getHighlightValue()
Return the value of the highlightValue
property.
public java.lang.String getInputTitle()
public void setInputTitle(java.lang.String inputTitle)
public void validate(javax.faces.context.FacesContext context)
validate
in class javax.faces.component.UIInput
|
ICEfaces ICE Components 3.3.0 Java API Documentation |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |