|
||||||||||
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
com.sun.webui.jsf.component.WebuiInput
com.sun.webui.jsf.component.Scheduler
public class Scheduler
The Scheduler component is used to display a calendar and the input controls that are used for selecting a date and time.
Field Summary | |
---|---|
static java.lang.String |
DATE_FACET
The date facet name. |
static java.lang.String |
DATE_LABEL_FACET
The date label facet name. |
static java.lang.String |
DATE_PICKER_FACET
The date picker facet name. |
static java.lang.String |
END_HOUR_TITLE_TEXT_KEY
The end hour title text key |
static java.lang.String |
END_MINUTE_TITLE_TEXT_KEY
The end minute title text key |
static java.lang.String |
END_TIME_FACET
The end time facet name. |
static java.lang.String |
END_TIME_LABEL_FACET
The end time facet name. |
static java.lang.String |
END_TIME_TEXT_KEY
The end time label text. |
static java.lang.String |
ICON_ID
|
static java.lang.String |
PREVIEW_BUTTON_FACET
The preview button facet name. |
static java.lang.String |
PREVIEW_BUTTON_TEXT_KEY
The preview button text key. |
static java.lang.String |
REPEAT_INTERVAL_DESCRIPTION_TEXT_KEY
The repeat interval descriptions text key. |
static java.lang.String |
REPEAT_INTERVAL_FACET
The repeat interval facet name. |
static java.lang.String |
REPEAT_INTERVAL_LABEL_FACET
The repeat interval label facet name. |
static java.lang.String |
REPEAT_INTERVAL_TEXT_KEY
The repeat interval label text. |
static java.lang.String |
REPEAT_LIMIT_FACET
The repeat limit facet name. |
static java.lang.String |
REPEAT_LIMIT_LABEL_FACET
The repeat limit label facet name. |
static java.lang.String |
REPEAT_LIMIT_TEXT_KEY
The repeat limit label text. |
static java.lang.String |
REPEAT_LIMIT_UNIT_FACET
The repeat unit facet name. |
static java.lang.String |
REPEAT_UNIT_DESCRIPTION_TEXT_KEY
The repeat unit descriptions text key. |
static java.lang.String |
START_DATE_TEXT_KEY
The start date label text. |
static java.lang.String |
START_HOUR_TITLE_TEXT_KEY
The start hour title text key |
static java.lang.String |
START_MINUTE_TITLE_TEXT_KEY
The start minute title text key |
static java.lang.String |
START_TIME_FACET
The start time facet name. |
static java.lang.String |
START_TIME_LABEL_FACET
The start time facet name. |
static java.lang.String |
START_TIME_TEXT_KEY
The start time label text. |
Fields inherited from class javax.faces.component.UIInput |
---|
COMPONENT_FAMILY, COMPONENT_TYPE, CONVERSION_MESSAGE_ID, REQUIRED_MESSAGE_ID, UPDATE_MESSAGE_ID |
Fields inherited from interface javax.faces.component.NamingContainer |
---|
SEPARATOR_CHAR |
Constructor Summary | |
---|---|
Scheduler()
Default constructor. |
Method Summary | |
---|---|
void |
encodeEnd(javax.faces.context.FacesContext context)
|
java.lang.Object |
getConvertedValue(javax.faces.context.FacesContext context,
java.lang.Object submittedValue)
Perform the following algorithm to validate the local value of this UIInput . |
javax.faces.convert.Converter |
getConverter()
|
javax.faces.component.UIComponent |
getDateComponent()
Return a component that implements a date input field. |
java.text.DateFormat |
getDateFormat()
|
java.lang.String |
getDateFormatPattern()
The date format pattern to use (i.e. |
java.lang.String |
getDateFormatPatternHelp()
A message below the text field for the date, indicating the string format to use when entering a date as text into the Start Date text field. |
java.lang.String |
getDateLabel()
This text replaces the "Start Date" label. |
javax.faces.component.UIComponent |
getDateLabelComponent(Theme theme)
Return a component that implements a label for the date component. |
com.sun.webui.jsf.component.CalendarMonth |
getDatePicker()
Return a CalendarMonth component that implements
the calendar for the Scheduler. |
Time |
getEndTimeComponent()
Return a Time component that implements the end time. |
java.lang.String |
getEndTimeLabel()
This text replaces the "End Time" label. |
javax.faces.component.UIComponent |
getEndTimeLabelComponent(Theme theme)
Return a component that implements a label for end time component. |
java.lang.String |
getFamily()
Return the family for this component. |
java.util.Date |
getFirstAvailableDate()
|
java.lang.String |
getFocusElementId(javax.faces.context.FacesContext context)
Returns the id of an HTML element suitable to receive the focus. |
javax.faces.component.UIComponent |
getIndicatorComponent(javax.faces.context.FacesContext context,
Label label)
Return a component instance that can be referenced by a Label in order to evaluate the required
and valid states of this component. |
java.lang.String |
getJavaScriptObjectName(javax.faces.context.FacesContext context)
|
java.lang.String |
getLabeledElementId(javax.faces.context.FacesContext context)
Returns the absolute ID of an HTML element suitable for use as the value of an HTML LABEL element's for attribute. |
java.util.Date |
getLastAvailableDate()
|
java.util.Date |
getMaxDate()
A java.util.Date object representing the last
selectable day. |
java.util.Date |
getMinDate()
A java.util.Date object representing the first
selectable day. |
javax.faces.component.UIComponent |
getPreviewButtonComponent()
Return a component that implements a preview button facet. |
java.lang.String |
getPrimaryElementID(javax.faces.context.FacesContext context)
Deprecated. |
javax.faces.component.UIComponent |
getRepeatingFieldComponent()
Return a component that implements a repeating limit input field. |
DropDown |
getRepeatIntervalComponent()
Return a DropDown component that implements a repeat interval menu. |
java.lang.Object |
getRepeatIntervalItems()
If the developer has not provided repeat interval items, return an Options array of RepeatIntervalOption
elements representing the following intervals. |
java.lang.String |
getRepeatIntervalLabel()
Override the default value of the label for the repeat interval menu. |
javax.faces.component.UIComponent |
getRepeatIntervalLabelComponent()
Return a component that implements a label for repeat interval component. |
java.lang.String |
getRepeatLimitLabel()
Override the default value of the label for the repeat limit menu. |
javax.faces.component.UIComponent |
getRepeatLimitLabelComponent()
Return a component that implements a label for the repeat limit component. |
DropDown |
getRepeatUnitComponent()
Return a DropDown component that implements a repeat unit menu. |
java.lang.Object |
getRepeatUnitItems()
If the developer has not provided repeat unit items, return an Options array of RepeatUnitOption
elements representing the following units. |
Time |
getStartTimeComponent()
Return a Time component that implements the start time. |
java.lang.String |
getStartTimeLabel()
This text replaces the "Start Time" label. |
javax.faces.component.UIComponent |
getStartTimeLabelComponent(Theme theme)
Return a component that implements a label for the start time component. |
java.lang.String |
getStyle()
CSS style(s) to be applied to the outermost HTML element when this component is rendered. |
java.lang.String |
getStyleClass()
CSS style class(es) to be applied to the outermost HTML element when this component is rendered. |
int |
getTabIndex()
Position of this element in the tabbing order of the current document. |
java.util.TimeZone |
getTimeZone()
The java.util.TimeZone used with this
component. |
boolean |
isDisabled()
Standard HTML attribute which determines whether the web application user can change the the value of this component. |
boolean |
isEndTime()
Flag indicating that an input field for the end time should be shown. |
boolean |
isLimitRepeating()
Flag indicating that a control for setting a limit for repeating events should be shown. |
boolean |
isPreviewButton()
Flag indicating that the "Preview in Browser" button should be displayed - default value is true. |
boolean |
isReadOnly()
If this attribute is set to true, the value of the component is rendered as text, preceded by the label if one was defined. |
boolean |
isRepeating()
Flag indicating that a control for scheduling a repeated event should be shown. |
boolean |
isRequired()
Flag indicating that the user must enter a value for this Scheduler. |
boolean |
isRequiredLegend()
Flag indicating if the "* indicates required field" message should be displayed - default value is true. |
boolean |
isStartTime()
Flag indicating that an input field for the start time should be shown. |
boolean |
isVisible()
Use the visible attribute to indicate whether the component should be viewable by the user in the rendered HTML page. |
void |
processDecodes(javax.faces.context.FacesContext context)
Specialized decode behavior on top of that provided by the superclass. |
void |
restoreState(javax.faces.context.FacesContext _context,
java.lang.Object _state)
Restore the state of this component. |
java.lang.Object |
saveState(javax.faces.context.FacesContext _context)
Save the state of this component. |
void |
setDateFormatPattern(java.lang.String dateFormatPattern)
The date format pattern to use (i.e. |
void |
setDateFormatPatternHelp(java.lang.String dateFormatPatternHelp)
A message below the text field for the date, indicating the string format to use when entering a date as text into the Start Date text field. |
void |
setDateLabel(java.lang.String dateLabel)
This text replaces the "Start Date" label. |
void |
setDisabled(boolean disabled)
Standard HTML attribute which determines whether the web application user can change the the value of this component. |
void |
setEndTime(boolean endTime)
Flag indicating that an input field for the end time should be shown. |
void |
setEndTimeLabel(java.lang.String endTimeLabel)
This text replaces the "End Time" label. |
void |
setLimitRepeating(boolean limitRepeating)
Flag indicating that a control for setting a limit for repeating events should be shown. |
void |
setMaxDate(java.util.Date maxDate)
A java.util.Date object representing the last
selectable day. |
void |
setMinDate(java.util.Date minDate)
A java.util.Date object representing the first
selectable day. |
void |
setPreviewButton(boolean previewButton)
Flag indicating that the "Preview in Browser" button should be displayed - default value is true. |
void |
setReadOnly(boolean readOnly)
If this attribute is set to true, the value of the component is rendered as text, preceded by the label if one was defined. |
void |
setRepeating(boolean repeating)
Flag indicating that a control for scheduling a repeated event should be shown. |
void |
setRepeatIntervalItems(java.lang.Object repeatIntervalItems)
Override the items that appear on the repeat interval menu. |
void |
setRepeatIntervalLabel(java.lang.String repeatIntervalLabel)
Override the default value of the label for the repeat interval menu. |
void |
setRepeatLimitLabel(java.lang.String repeatLimitLabel)
Override the default value of the label for the repeat limit menu. |
void |
setRepeatUnitItems(java.lang.Object repeatUnitItems)
Override the items that appear on the repeat limit unit menu. |
void |
setRequired(boolean required)
Flag indicating that the user must enter a value for this Scheduler. |
void |
setRequiredLegend(boolean requiredLegend)
Flag indicating if the "* indicates required field" message should be displayed - default value is true. |
void |
setStartTime(boolean startTime)
Flag indicating that an input field for the start time should be shown. |
void |
setStartTimeLabel(java.lang.String startTimeLabel)
This text replaces the "Start Time" label. |
void |
setStyle(java.lang.String style)
CSS style(s) to be applied to the outermost HTML element when this component is rendered. |
void |
setStyleClass(java.lang.String styleClass)
CSS style class(es) to be applied to the outermost HTML element when this component is rendered. |
void |
setTabIndex(int tabIndex)
Position of this element in the tabbing order of the current document. |
void |
setTimeZone(java.util.TimeZone timeZone)
The java.util.TimeZone used with this
component. |
void |
setValue(java.lang.Object value)
The current value of this component. |
void |
setVisible(boolean visible)
Use the visible attribute to indicate whether the component should be viewable by the user in the rendered HTML page. |
void |
updateRepeatUnitMenu()
Called from IntervalListener, enable or disable dependent facets. |
Methods inherited from class com.sun.webui.jsf.component.WebuiInput |
---|
broadcast, getValidator, getValidatorExpression, getValueChangeListener, getValueChangeListenerExpression, processUpdates, processValidators, setConverter, setId, setImmediate, setRendered, setValidatorExpression, setValueChangeListenerExpression |
Methods inherited from class javax.faces.component.UIInput |
---|
addValidator, addValueChangeListener, decode, getConverterMessage, getRequiredMessage, getSubmittedValue, getValidatorMessage, getValidators, getValueChangeListeners, isImmediate, isLocalValueSet, isValid, removeValidator, removeValueChangeListener, resetValue, setConverterMessage, setLocalValueSet, setRequiredMessage, setSubmittedValue, setValid, setValidator, setValidatorMessage, setValueChangeListener, updateModel, validate |
Methods inherited from class javax.faces.component.UIOutput |
---|
getLocalValue, getValue |
Methods inherited from class javax.faces.component.UIComponentBase |
---|
encodeBegin, encodeChildren, findComponent, getAttributes, getChildCount, getChildren, getClientId, getFacet, getFacetCount, getFacets, getFacetsAndChildren, getId, getParent, getRendererType, getRendersChildren, getValueBinding, getValueExpression, invokeOnComponent, isRendered, isTransient, processRestoreState, processSaveState, queueEvent, restoreAttachedState, saveAttachedState, setParent, setRendererType, setTransient, setValueBinding, setValueExpression |
Methods inherited from class javax.faces.component.UIComponent |
---|
encodeAll, getContainerClientId |
Methods inherited from class java.lang.Object |
---|
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Methods inherited from interface javax.faces.component.ValueHolder |
---|
getLocalValue, getValue |
Field Detail |
---|
public static final java.lang.String DATE_PICKER_FACET
public static final java.lang.String DATE_FACET
public static final java.lang.String DATE_LABEL_FACET
public static final java.lang.String START_DATE_TEXT_KEY
public static final java.lang.String START_TIME_FACET
public static final java.lang.String START_TIME_LABEL_FACET
public static final java.lang.String START_TIME_TEXT_KEY
public static final java.lang.String END_TIME_FACET
public static final java.lang.String END_TIME_LABEL_FACET
public static final java.lang.String END_TIME_TEXT_KEY
public static final java.lang.String REPEAT_LIMIT_UNIT_FACET
public static final java.lang.String REPEAT_UNIT_DESCRIPTION_TEXT_KEY
public static final java.lang.String REPEAT_LIMIT_FACET
public static final java.lang.String REPEAT_LIMIT_LABEL_FACET
public static final java.lang.String REPEAT_LIMIT_TEXT_KEY
public static final java.lang.String REPEAT_INTERVAL_FACET
public static final java.lang.String REPEAT_INTERVAL_LABEL_FACET
public static final java.lang.String REPEAT_INTERVAL_TEXT_KEY
public static final java.lang.String REPEAT_INTERVAL_DESCRIPTION_TEXT_KEY
public static final java.lang.String PREVIEW_BUTTON_FACET
public static final java.lang.String PREVIEW_BUTTON_TEXT_KEY
public static final java.lang.String START_HOUR_TITLE_TEXT_KEY
public static final java.lang.String START_MINUTE_TITLE_TEXT_KEY
public static final java.lang.String END_HOUR_TITLE_TEXT_KEY
public static final java.lang.String END_MINUTE_TITLE_TEXT_KEY
public static final java.lang.String ICON_ID
Constructor Detail |
---|
public Scheduler()
Method Detail |
---|
public java.lang.String getFamily()
Return the family for this component.
getFamily
in class javax.faces.component.UIInput
public com.sun.webui.jsf.component.CalendarMonth getDatePicker()
CalendarMonth
component that implements
the calendar for the Scheduler.
This is a private facet.
public javax.faces.component.UIComponent getDateLabelComponent(Theme theme)
dateLabel
is found
that component is returned. Otherwise a Label
component
is returned. It is assigned the id
getId() + "_dateLabel"
If the facet is not defined then the returned Label
component is re-intialized every time this method is called.
public javax.faces.component.UIComponent getDateComponent()
date
is found
that component is returned. Otherwise a TextField
component
is returned. It is assigned the id
getId() + "_date"
If the facet is not defined then the returned TextField
component is re-intialized every time this method is called.
public javax.faces.component.UIComponent getStartTimeLabelComponent(Theme theme)
startTimeLabel
is found
that component is returned. Otherwise a Label
component
is returned. It is assigned the id
getId() + "_startTimeLabel"
If the facet is not defined then the returned Label
component is re-intialized every time this method is called.
public Time getStartTimeComponent()
ComponentUtilities.getPrivateFacet()
returns a facet named startTime
that component is initialized every time this
method is called and returned.
This is a private facet.
Otherwise aTime
component
is created and initialized. It is assigned the id
getId() + "_startTime"
and added to the facets map
as a private facet.
public javax.faces.component.UIComponent getEndTimeLabelComponent(Theme theme)
endTimeLabel
is found
that component is returned. Otherwise a Label
component
is returned. It is assigned the id
getId() + "_endTimeLabel"
If the facet is not defined then the returned Label
component is re-intialized every time this method is called.
public Time getEndTimeComponent()
ComponentUtilities.getPrivateFacet()
returns a facet named endTime
that component is initialized every time this
method is called and returned.
This is a private facet.
Otherwise aTime
component
is created and initialized. It is assigned the id
getId() + "_endTime"
and added to the facets map
as a private facet.
public javax.faces.component.UIComponent getRepeatIntervalLabelComponent()
repeatIntervalLabel
is found
that component is returned. Otherwise a Label
component
is returned. It is assigned the id
getId() + "_repeatIntervalLabel"
If the facet is not defined then the returned Label
component is re-intialized every time this method is called.
public DropDown getRepeatIntervalComponent()
ComponentUtilities.getPrivateFacet()
returns a facet named repeatInterval
that component is initialized every time this
method is called and returned.
This is a private facet.
Otherwise aDropDown
component
is created and initialized. It is assigned the id
getId() + "_repeatInterval"
and added to the facets map
as a private facet.
public javax.faces.component.UIComponent getRepeatLimitLabelComponent()
repeatLimitLabel
is found
that component is returned. Otherwise a Label
component
is returned. It is assigned the id
getId() + "_repeatLimitLabel"
If the facet is not defined then the returned Label
component is re-intialized every time this method is called.
public javax.faces.component.UIComponent getRepeatingFieldComponent()
repeatLimit
is found
that component is returned. Otherwise a TextField
component
is returned. It is assigned the id
getId() + "_repeatLimit"
If the facet is not defined then the returned TextField
component is re-intialized every time this method is called.
public DropDown getRepeatUnitComponent()
ComponentUtilities.getPrivateFacet()
returns a facet named repeatLimitUnit
that component is initialized every time this
method is called and returned.
This is a private facet.
Otherwise aDropDown
component
is created and initialized. It is assigned the id
getId() + "_repeatLimitUnit"
and added to the facets map
as a private facet.
public javax.faces.component.UIComponent getPreviewButtonComponent()
previewButton
is found
that component is returned. Otherwise a Button
component
is returned. It is assigned the id
getId() + "_previewButton"
If the facet is not defined then the returned Button
component is re-intialized every time this method is called.
public void updateRepeatUnitMenu()
RepeatInterval
and is
RepeatInterval.ONETIME then disable
the REPEAT_LIMIT_FACET and REPEAT_INTERVAL_FACET facets. This
includes setting the values of the facets to null.
Otherwise enable both facets.
If the value is null or not an instance of RepeatInterval
then disable the REPEAT_LIMIT_FACET and REPEAT_INTERVAL_FACET
facets as described above.
public java.lang.String getPrimaryElementID(javax.faces.context.FacesContext context)
getPrimaryElementID
in interface com.sun.webui.jsf.component.ComplexComponent
context
- The FacesContext for the request
getLabeledElementId(javax.faces.context.FacesContext)
,
getFocusElementId(javax.faces.context.FacesContext)
public java.lang.String getLabeledElementId(javax.faces.context.FacesContext context)
for
attribute.
If the ComplexComponent
has sub-compoents, and one of
the sub-components is the target of a label, if that sub-component
is a ComplexComponent
, then
getLabeledElementId
must called on the sub-component and
the value returned. The value returned by this
method call may or may not resolve to a component instance.
This implementation returns the id of the component returned by
getDateComponent
. If that method returns null
null
is returned.
getLabeledElementId
in interface com.sun.webui.jsf.component.ComplexComponent
context
- The FacesContext used for the request
for
attribute.public java.lang.String getFocusElementId(javax.faces.context.FacesContext context)
ComplexComponent
has sub-compoents, and one of
the sub-components is to reveive the focus, if that sub-component
is a ComplexComponent
, then
getFocusElementId
must called on the sub-component and
the value returned. The value returned by this
method call may or may not resolve to a component instance.
This implementation returns the value of
getLabeledElementId
.
getFocusElementId
in interface com.sun.webui.jsf.component.ComplexComponent
context
- The FacesContext used for the requestpublic javax.faces.component.UIComponent getIndicatorComponent(javax.faces.context.FacesContext context, Label label)
Label
in order to evaluate the required
and valid
states of this component.
getIndicatorComponent
in interface com.sun.webui.jsf.component.ComplexComponent
context
- The current FacesContext
instancelabel
- The Label
that labels this component.
UIComponent
in order to evaluate the
required and valid states.public java.lang.Object getRepeatIntervalItems()
Options
array of RepeatIntervalOption
elements representing the following intervals.
public java.lang.Object getRepeatUnitItems()
Options
array of RepeatUnitOption
elements representing the following units.
public java.text.DateFormat getDateFormat()
getDateFormat
in interface DateManager
public java.lang.String getJavaScriptObjectName(javax.faces.context.FacesContext context)
public void processDecodes(javax.faces.context.FacesContext context)
Specialized decode behavior on top of that provided by the
superclass. In addition to the standard
processDecodes
behavior inherited from UIComponentBase
, calls validate()
if the the
immediate
property is true; if the component is
invalid afterwards or a RuntimeException
is thrown,
calls FacesContext.renderResponse()
.
processDecodes
in class WebuiInput
context
- FacesContext
for this request.
java.lang.NullPointerException
public java.lang.Object getConvertedValue(javax.faces.context.FacesContext context, java.lang.Object submittedValue) throws javax.faces.convert.ConverterException
Perform the following algorithm to validate the local value of
this UIInput
.
getSubmittedValue()
.
If this returns null, exit without further processing. (This
indicates that no value was submitted for this component.)getConvertedValue(javax.faces.context.FacesContext, java.lang.Object)
.WebuiInput.validateValue(javax.faces.context.FacesContext, java.lang.Object)
.valid
property of this component is still
true
, retrieve the previous value of the component
(with getValue()
), store the new local value using
setValue()
, and reset the submitted value to
null. If the local value is different from
the previous value of this component, fire a
ValueChangeEvent
to be broadcast to all interested
listeners.Application components implementing UIInput
that wish to
perform validation with logic embedded in the component should perform
their own correctness checks, and then call the
super.validate()
method to perform the standard
processing described above.
getConvertedValue
in class javax.faces.component.UIInput
context
- The FacesContext
for the current request
javax.faces.convert.ConverterException
public void encodeEnd(javax.faces.context.FacesContext context) throws java.io.IOException
encodeEnd
in class javax.faces.component.UIComponentBase
java.lang.NullPointerException
java.io.IOException
public java.util.Date getFirstAvailableDate()
getFirstAvailableDate
in interface DateManager
public java.util.Date getLastAvailableDate()
getLastAvailableDate
in interface DateManager
public void setValue(java.lang.Object value)
setValue
in interface javax.faces.component.ValueHolder
setValue
in class javax.faces.component.UIInput
public javax.faces.convert.Converter getConverter()
getConverter
in interface javax.faces.component.ValueHolder
getConverter
in class javax.faces.component.UIOutput
public java.lang.String getDateFormatPattern()
The date format pattern to use (i.e. yyyy-MM-dd). The
component uses an instance of
java.text.SimpleDateFormat
and you may specify
a pattern to be used by this component, with the following
restriction: the format pattern must include yyyy
(not
yy
), MM
, and dd
; and no
other parts of time may be displayed. If a pattern is not
specified, a locale-specific default is used.
If you change the date format pattern, you may also need to
change the dateFormatPatternHelp
attribute. See the
documentation for that attribute.
getDateFormatPattern
in interface DateManager
public void setDateFormatPattern(java.lang.String dateFormatPattern)
The date format pattern to use (i.e. yyyy-MM-dd). The
component uses an instance of
java.text.SimpleDateFormat
and you may specify
a pattern to be used by this component, with the following
restriction: the format pattern must include yyyy
(not
yy
), MM
, and dd
; and no
other parts of time may be displayed. If a pattern is not
specified, a locale-specific default is used.
If you change the date format pattern, you may also need to
change the dateFormatPatternHelp
attribute. See the
documentation for that attribute.
getDateFormatPattern()
public java.lang.String getDateFormatPatternHelp()
A message below the text field for the date, indicating the string format to use when entering a date as text into the Start Date text field.
The component internally relies on an instance of
java.text.SimpleDateFormat
to produce the hint.
The default hint is constructed by invoking the
toLocalizedPattern()
method on the
SimpleDateFormat
instance and converting this
String to lower case.
Due to a bug in
SimpleDateFormat
,
toLocalizedPattern()
does not actually produce
locale-appropriate strings for most locales (it works for
German, but not for other locales). If the default value for
the dateFormtPattern
is used, the
component takes care of the localization itself, but if the default
is overridden, you may need to override the hint on a
per-locale basis too.
public void setDateFormatPatternHelp(java.lang.String dateFormatPatternHelp)
A message below the text field for the date, indicating the string format to use when entering a date as text into the Start Date text field.
The component internally relies on an instance of
java.text.SimpleDateFormat
to produce the hint.
The default hint is constructed by invoking the
toLocalizedPattern()
method on the
SimpleDateFormat
instance and converting this
String to lower case.
Due to a bug in
SimpleDateFormat
,
toLocalizedPattern()
does not actually produce
locale-appropriate strings for most locales (it works for
German, but not for other locales). If the default value for
the dateFormtPattern
is used, the
component takes care of the localization itself, but if the default
is overridden, you may need to override the hint on a
per-locale basis too.
getDateFormatPatternHelp()
public java.lang.String getDateLabel()
This text replaces the "Start Date" label.
public void setDateLabel(java.lang.String dateLabel)
This text replaces the "Start Date" label.
getDateLabel()
public boolean isDisabled()
Standard HTML attribute which determines whether the web application user can change the the value of this component. NOT YET IMPLEMENTED.
public void setDisabled(boolean disabled)
Standard HTML attribute which determines whether the web application user can change the the value of this component. NOT YET IMPLEMENTED.
isDisabled()
public boolean isEndTime()
Flag indicating that an input field for the end time should be shown. The default value is true.
public void setEndTime(boolean endTime)
Flag indicating that an input field for the end time should be shown. The default value is true.
isEndTime()
public java.lang.String getEndTimeLabel()
This text replaces the "End Time" label.
public void setEndTimeLabel(java.lang.String endTimeLabel)
This text replaces the "End Time" label.
getEndTimeLabel()
public boolean isLimitRepeating()
Flag indicating that a control for setting a limit for repeating events should be shown. The default value is true.
public void setLimitRepeating(boolean limitRepeating)
Flag indicating that a control for setting a limit for repeating events should be shown. The default value is true.
isLimitRepeating()
public java.util.Date getMaxDate()
A java.util.Date
object representing the last
selectable day. The default value is four years after the
minDate
(which is evaluated first).
The value of this attribute is reflected in the years that are available for selection in the month display. In future releases of this component, web application users will also not be able to view months after this date, or select days that follow this date. At present such dates can be selected, but will not be validated when the form is submitted.
public void setMaxDate(java.util.Date maxDate)
A java.util.Date
object representing the last
selectable day. The default value is four years after the
minDate
(which is evaluated first).
The value of this attribute is reflected in the years that are available for selection in the month display. In future releases of this component, web application users will also not be able to view months after this date, or select days that follow this date. At present such dates can be selected, but will not be validated when the form is submitted.
getMaxDate()
public java.util.Date getMinDate()
A java.util.Date
object representing the first
selectable day. The default value is today's date.
The value of this attribute is reflected in the years that are available for selection in the month display. In future releases of this component, web application users will also not be able to view months before this date, or select days that precede this date. At present such dates can be selected, but will not be validated when the form is submitted.
public void setMinDate(java.util.Date minDate)
A java.util.Date
object representing the first
selectable day. The default value is today's date.
The value of this attribute is reflected in the years that are available for selection in the month display. In future releases of this component, web application users will also not be able to view months before this date, or select days that precede this date. At present such dates can be selected, but will not be validated when the form is submitted.
getMinDate()
public boolean isPreviewButton()
Flag indicating that the "Preview in Browser" button should be displayed - default value is true.
public void setPreviewButton(boolean previewButton)
Flag indicating that the "Preview in Browser" button should be displayed - default value is true.
isPreviewButton()
public boolean isReadOnly()
If this attribute is set to true, the value of the component is rendered as text, preceded by the label if one was defined. NOT YET IMPLEMENTED.
public void setReadOnly(boolean readOnly)
If this attribute is set to true, the value of the component is rendered as text, preceded by the label if one was defined. NOT YET IMPLEMENTED.
isReadOnly()
public void setRepeatIntervalItems(java.lang.Object repeatIntervalItems)
Override the items that appear on the repeat interval menu.
The value must be one of an array, Map or Collection
whose members are all subclasses of
com.sun.webui.jsf.model.scheduler.RepeatIntervalOption
,
whose values must be one of the member classes of
com.sun.webui.jsf.model.scheduler.RepeatInterval
,
for example
com.sun.webui.jsf.model.scheduler.RepeatInterval.ONETIME
or
com.sun.webui.jsf.model.scheduler.RepeatInterval.HOURLY
.
If this attribute is not specified, default options of "One Time",
"Hourly", "Weekly", "Monthtly" will be shown.
getRepeatIntervalItems()
public java.lang.String getRepeatIntervalLabel()
Override the default value of the label for the repeat interval menu.
public void setRepeatIntervalLabel(java.lang.String repeatIntervalLabel)
Override the default value of the label for the repeat interval menu.
getRepeatIntervalLabel()
public java.lang.String getRepeatLimitLabel()
Override the default value of the label for the repeat limit menu.
public void setRepeatLimitLabel(java.lang.String repeatLimitLabel)
Override the default value of the label for the repeat limit menu.
getRepeatLimitLabel()
public void setRepeatUnitItems(java.lang.Object repeatUnitItems)
Override the items that appear on the repeat limit unit menu.
The value must be one of an array, Map or Collection
whose members are all subclasses of
com.sun.webui.jsf.model.Option
, and the value of
the options must implement the
com.sun.webui.jsf.model.RepeatUnit
interface.
The default value is to show a menu with values "Hours",
"Days", "Weeks", "Months".
getRepeatUnitItems()
public boolean isRepeating()
Flag indicating that a control for scheduling a repeated event should be shown. The default value is true.
public void setRepeating(boolean repeating)
Flag indicating that a control for scheduling a repeated event should be shown. The default value is true.
isRepeating()
public boolean isRequired()
Flag indicating that the user must enter a value for this Scheduler. Default value is true.
isRequired
in interface javax.faces.component.EditableValueHolder
isRequired
in class javax.faces.component.UIInput
public void setRequired(boolean required)
Flag indicating that the user must enter a value for this Scheduler. Default value is true.
setRequired
in interface javax.faces.component.EditableValueHolder
setRequired
in class WebuiInput
isRequired()
public boolean isRequiredLegend()
Flag indicating if the "* indicates required field" message should be displayed - default value is true.
public void setRequiredLegend(boolean requiredLegend)
Flag indicating if the "* indicates required field" message should be displayed - default value is true.
isRequiredLegend()
public boolean isStartTime()
Flag indicating that an input field for the start time should be shown. The default value is true.
public void setStartTime(boolean startTime)
Flag indicating that an input field for the start time should be shown. The default value is true.
isStartTime()
public java.lang.String getStartTimeLabel()
This text replaces the "Start Time" label.
public void setStartTimeLabel(java.lang.String startTimeLabel)
This text replaces the "Start Time" label.
getStartTimeLabel()
public java.lang.String getStyle()
CSS style(s) to be applied to the outermost HTML element when this component is rendered.
public void setStyle(java.lang.String style)
CSS style(s) to be applied to the outermost HTML element when this component is rendered.
getStyle()
public java.lang.String getStyleClass()
CSS style class(es) to be applied to the outermost HTML element when this component is rendered.
public void setStyleClass(java.lang.String styleClass)
CSS style class(es) to be applied to the outermost HTML element when this component is rendered.
getStyleClass()
public int getTabIndex()
Position of this element in the tabbing order of the current document. Tabbing order determines the sequence in which elements receive focus when the tab key is pressed. The value must be an integer between 0 and 32767.
public void setTabIndex(int tabIndex)
Position of this element in the tabbing order of the current document. Tabbing order determines the sequence in which elements receive focus when the tab key is pressed. The value must be an integer between 0 and 32767.
getTabIndex()
public java.util.TimeZone getTimeZone()
The java.util.TimeZone
used with this
component. Unless set, the default TimeZone for the locale in
javax.faces.component.UIViewRoot
is used.
getTimeZone
in interface DateManager
public void setTimeZone(java.util.TimeZone timeZone)
The java.util.TimeZone
used with this
component. Unless set, the default TimeZone for the locale in
javax.faces.component.UIViewRoot
is used.
getTimeZone()
public boolean isVisible()
Use the visible attribute to indicate whether the component should be viewable by the user in the rendered HTML page. If set to false, the HTML code for the component is present in the page, but the component is hidden with style attributes. By default, visible is set to true, so HTML for the component HTML is included and visible to the user. If the component is not visible, it can still be processed on subsequent form submissions because the HTML is present.
public void setVisible(boolean visible)
Use the visible attribute to indicate whether the component should be viewable by the user in the rendered HTML page. If set to false, the HTML code for the component is present in the page, but the component is hidden with style attributes. By default, visible is set to true, so HTML for the component HTML is included and visible to the user. If the component is not visible, it can still be processed on subsequent form submissions because the HTML is present.
isVisible()
public void restoreState(javax.faces.context.FacesContext _context, java.lang.Object _state)
Restore the state of this component.
restoreState
in interface javax.faces.component.StateHolder
restoreState
in class WebuiInput
public java.lang.Object saveState(javax.faces.context.FacesContext _context)
Save the state of this component.
saveState
in interface javax.faces.component.StateHolder
saveState
in class WebuiInput
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |