com.liferay.faces.alloy.component.inputtime

Class InputTimeBase

java.lang.Object

javax.faces.component.UIComponent

javax.faces.component.UIComponentBase

javax.faces.component.UIOutput

javax.faces.component.UIInput

javax.faces.component.html.HtmlInputText

com.liferay.faces.alloy.component.inputtext.InputTextBase

com.liferay.faces.alloy.component.inputdatetime.InputDateTimeBase

com.liferay.faces.alloy.component.inputdatetime.InputDateTime

com.liferay.faces.alloy.component.inputtime.InputTimeBase

All Implemented Interfaces:

com.liferay.faces.util.component.ClientComponent, com.liferay.faces.util.component.Styleable, EventListener, javax.faces.component.behavior.ClientBehaviorHolder, javax.faces.component.EditableValueHolder, javax.faces.component.PartialStateHolder, javax.faces.component.StateHolder, javax.faces.component.TransientStateHolder, javax.faces.component.ValueHolder, javax.faces.event.ComponentSystemEventListener, javax.faces.event.FacesListener, javax.faces.event.SystemEventListenerHolder

Direct Known Subclasses:

InputTime

@Generated(value="com.liferay.alloy.tools.builder.FacesBuilder")
public abstract class InputTimeBase
extends InputDateTime
implements com.liferay.faces.util.component.Styleable

Author:

Bruno Basto, Kyle Stiemann

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected static class	InputTimeBase.InputTimePropertyKeys

Nested classes/interfaces inherited from class com.liferay.faces.alloy.component.inputdatetime.InputDateTimeBase

InputDateTimeBase.InputDateTimePropertyKeys

Nested classes/interfaces inherited from class javax.faces.component.html.HtmlInputText

javax.faces.component.html.HtmlInputText.PropertyKeys

Field Summary

Fields

Modifier and Type	Field and Description
static String	COMPONENT_TYPE
static String	RENDERER_TYPE

Fields inherited from class javax.faces.component.UIInput

COMPONENT_FAMILY, 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.liferay.faces.util.component.Styleable

STYLE, STYLE_CLASS

Fields inherited from interface com.liferay.faces.util.component.ClientComponent

CLIENT_KEY

Constructor Summary

Constructors

Constructor and Description
InputTimeBase()

Method Summary

Methods

Modifier and Type	Method and Description
Boolean	getCircular() circular attribute description: When true, the autoComplete list will wrap around allowing users to use keyboard navigation to move from the top of the list to the bottom and vice versa.
String	getFilterType() filterType attribute description: Specifies the type of filter that will be used for the pickTime's autocompletion.
String	getHeight() height attribute description: The the height (in pixels) of the rendered autoComplete list.
String	getHighlighterType() highlighterType attribute description: Specifies the type of filter that will be used for the pickTime's autocomplete highlighter.
Integer	getMaxResults() maxResults attribute description: The maximum amount of autoComplete results.
String	getMaxTime() maxTime attribute description: The maximum time that can be selected by the user.
String	getMinTime() minTime attribute description: The minimum time that can be selected by the user.
String	getPattern() pattern attribute description: The format of the time that corresponds to patterns described in the javadoc for java.text.SimpleDateFormat.
Integer	getQueryDelay() queryDelay attribute description: The delay in milliseconds before a query occurs.
Boolean	getScrollIntoView() scrollIntoView attribute description: When true, if the active option of the autoComplete is not in view, the view will be scrolled to make the active option is displayed to the user.
Integer	getStep() step attribute description: The step in seconds between each selectable timestamp.
String	getStyleClass() styleClass attribute description: List of CSS class names (separated by spaces) that are to be rendered within the class attribute.
boolean	isActivateFirstItem() activateFirstItem attribute description: When true, the first item in the list will be activated so that users can press TAB or ENTER to select it.
boolean	isNativeWhenMobile() nativeWhenMobile attribute description: When true, the component will render an HTML5 <input type="time" /> element on small/mobile displays in order to enable selection of a time with the mobile device's native UI.
void	setActivateFirstItem(boolean activateFirstItem) activateFirstItem attribute description: When true, the first item in the list will be activated so that users can press TAB or ENTER to select it.
void	setCircular(Boolean circular) circular attribute description: When true, the autoComplete list will wrap around allowing users to use keyboard navigation to move from the top of the list to the bottom and vice versa.
void	setFilterType(String filterType) filterType attribute description: Specifies the type of filter that will be used for the pickTime's autocompletion.
void	setHeight(String height) height attribute description: The the height (in pixels) of the rendered autoComplete list.
void	setHighlighterType(String highlighterType) highlighterType attribute description: Specifies the type of filter that will be used for the pickTime's autocomplete highlighter.
void	setMaxResults(Integer maxResults) maxResults attribute description: The maximum amount of autoComplete results.
void	setMaxTime(String maxTime) maxTime attribute description: The maximum time that can be selected by the user.
void	setMinTime(String minTime) minTime attribute description: The minimum time that can be selected by the user.
void	setNativeWhenMobile(boolean nativeWhenMobile) nativeWhenMobile attribute description: When true, the component will render an HTML5 <input type="time" /> element on small/mobile displays in order to enable selection of a time with the mobile device's native UI.
void	setPattern(String pattern) pattern attribute description: The format of the time that corresponds to patterns described in the javadoc for java.text.SimpleDateFormat.
void	setQueryDelay(Integer queryDelay) queryDelay attribute description: The delay in milliseconds before a query occurs.
void	setScrollIntoView(Boolean scrollIntoView) scrollIntoView attribute description: When true, if the active option of the autoComplete is not in view, the view will be scrolled to make the active option is displayed to the user.
void	setStep(Integer step) step attribute description: The step in seconds between each selectable timestamp.

Methods inherited from class com.liferay.faces.alloy.component.inputdatetime.InputDateTime

getConverter, getLocale, getLocale, getObjectAsDate, getObjectAsLocale, validateValue

Methods inherited from class com.liferay.faces.alloy.component.inputdatetime.InputDateTimeBase

getAutoHide, getClientKey, getShowOn, getTimeZone, getzIndex, setAutoHide, setClientKey, setLocale, setShowOn, setTimeZone, setzIndex

Methods inherited from class com.liferay.faces.alloy.component.inputtext.InputTextBase

getLabel

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

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

Methods inherited from class javax.faces.component.UIInput

addValidator, addValueChangeListener, clearInitialState, compareValues, decode, getConvertedValue, getConverterMessage, getFamily, 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, broadcast, encodeBegin, encodeChildren, encodeEnd, findComponent, getAttributes, getChildCount, getChildren, getClientBehaviors, getClientId, getFacesContext, getFacesListeners, getFacet, getFacetCount, getFacets, getFacetsAndChildren, getId, getListenersForEventClass, getParent, getPassThroughAttributes, getRenderer, getRendererType, getRendersChildren, getValueBinding, invokeOnComponent, isRendered, isTransient, processRestoreState, processSaveState, queueEvent, removeFacesListener, restoreAttachedState, saveAttachedState, setId, setParent, setRendered, setRendererType, setTransient, setValueBinding, subscribeToEvent, unsubscribeFromEvent

Methods inherited from class javax.faces.component.UIComponent

encodeAll, getClientId, getCompositeComponentParent, getContainerClientId, getCurrentComponent, getCurrentCompositeComponent, getNamingContainer, getPassThroughAttributes, 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 com.liferay.faces.util.component.Styleable

getStyle, setStyle, setStyleClass

Methods inherited from interface com.liferay.faces.util.component.ClientComponent

getClientId

Methods inherited from interface javax.faces.component.behavior.ClientBehaviorHolder

addClientBehavior, getClientBehaviors

Methods inherited from interface javax.faces.component.ValueHolder

getLocalValue, setConverter

Field Detail

COMPONENT_TYPE

public static final String COMPONENT_TYPE

See Also:

Constant Field Values

RENDERER_TYPE

public static final String RENDERER_TYPE

See Also:

Constant Field Values

Constructor Detail

InputTimeBase

public InputTimeBase()

Method Detail

isActivateFirstItem

public boolean isActivateFirstItem()

activateFirstItem attribute description:

When true, the first item in the list will be activated so that users can press TAB or ENTER to select it.

setActivateFirstItem

public void setActivateFirstItem(boolean activateFirstItem)

activateFirstItem attribute description:

When true, the first item in the list will be activated so that users can press TAB or ENTER to select it.

getCircular

public Boolean getCircular()

circular attribute description:

When true, the autoComplete list will wrap around allowing users to use keyboard navigation to move from the top of the list to the bottom and vice versa. The default value is true.

setCircular

public void setCircular(Boolean circular)

circular attribute description:

When true, the autoComplete list will wrap around allowing users to use keyboard navigation to move from the top of the list to the bottom and vice versa. The default value is true.

getFilterType

public String getFilterType()

filterType attribute description:

Specifies the type of filter that will be used for the pickTime's autocompletion. Valid values include:

• charMatch
• charMatchCase
• phraseMatch
• phraseMatchCase
• startsWith
• startsWithCase
• subWordMatch
• subWordMatchCase
• wordMatch
• wordMatchCase

setFilterType

public void setFilterType(String filterType)

filterType attribute description:

Specifies the type of filter that will be used for the pickTime's autocompletion. Valid values include:

• charMatch
• charMatchCase
• phraseMatch
• phraseMatchCase
• startsWith
• startsWithCase
• subWordMatch
• subWordMatchCase
• wordMatch
• wordMatchCase

getHeight

public String getHeight()

height attribute description:

The the height (in pixels) of the rendered autoComplete list.

setHeight

public void setHeight(String height)

height attribute description:

The the height (in pixels) of the rendered autoComplete list.

getHighlighterType

public String getHighlighterType()

highlighterType attribute description:

Specifies the type of filter that will be used for the pickTime's autocomplete highlighter. Valid values include:

• charMatch
• charMatchCase
• phraseMatch
• phraseMatchCase
• startsWith
• startsWithCase
• subWordMatch
• subWordMatchCase
• wordMatch
• wordMatchCase

setHighlighterType

public void setHighlighterType(String highlighterType)

highlighterType attribute description:

Specifies the type of filter that will be used for the pickTime's autocomplete highlighter. Valid values include:

• charMatch
• charMatchCase
• phraseMatch
• phraseMatchCase
• startsWith
• startsWithCase
• subWordMatch
• subWordMatchCase
• wordMatch
• wordMatchCase

getMaxResults

public Integer getMaxResults()

maxResults attribute description:

The maximum amount of autoComplete results.

setMaxResults

public void setMaxResults(Integer maxResults)

maxResults attribute description:

The maximum amount of autoComplete results.

getMaxTime

public String getMaxTime()

maxTime attribute description:

The maximum time that can be selected by the user. maxTime can be of type java.lang.String (of the pattern "HH:mm:ss") or java.util.Date.

setMaxTime

public void setMaxTime(String maxTime)

maxTime attribute description:

The maximum time that can be selected by the user. maxTime can be of type java.lang.String (of the pattern "HH:mm:ss") or java.util.Date.

getMinTime

public String getMinTime()

minTime attribute description:

The minimum time that can be selected by the user. minTime can be of type java.lang.String (of the pattern "HH:mm:ss") or java.util.Date.

setMinTime

public void setMinTime(String minTime)

minTime attribute description:

The minimum time that can be selected by the user. minTime can be of type java.lang.String (of the pattern "HH:mm:ss") or java.util.Date.

isNativeWhenMobile

public boolean isNativeWhenMobile()

nativeWhenMobile attribute description:

When true, the component will render an HTML5 <input type="time" /> element on small/mobile displays in order to enable selection of a time with the mobile device's native UI.

Overrides:

isNativeWhenMobile in class InputDateTimeBase

setNativeWhenMobile

public void setNativeWhenMobile(boolean nativeWhenMobile)

nativeWhenMobile attribute description:

When true, the component will render an HTML5 <input type="time" /> element on small/mobile displays in order to enable selection of a time with the mobile device's native UI.

Overrides:

setNativeWhenMobile in class InputDateTimeBase

getPattern

public String getPattern()

pattern attribute description:

The format of the time that corresponds to patterns described in the javadoc for java.text.SimpleDateFormat.

Specified by:

getPattern in class InputDateTime

setPattern

public void setPattern(String pattern)

pattern attribute description:

The format of the time that corresponds to patterns described in the javadoc for java.text.SimpleDateFormat.

getQueryDelay

public Integer getQueryDelay()

queryDelay attribute description:

The delay in milliseconds before a query occurs. After the autoComplete receives input, it waits the specified number of milliseconds before querying it's source. If input occurs before the specified number of milliseconds has elapsed, the timer is reset.

setQueryDelay

public void setQueryDelay(Integer queryDelay)

queryDelay attribute description:

The delay in milliseconds before a query occurs. After the autoComplete receives input, it waits the specified number of milliseconds before querying it's source. If input occurs before the specified number of milliseconds has elapsed, the timer is reset.

getScrollIntoView

public Boolean getScrollIntoView()

scrollIntoView attribute description:

When true, if the active option of the autoComplete is not in view, the view will be scrolled to make the active option is displayed to the user.

setScrollIntoView

public void setScrollIntoView(Boolean scrollIntoView)

scrollIntoView attribute description:

When true, if the active option of the autoComplete is not in view, the view will be scrolled to make the active option is displayed to the user.

getStep

public Integer getStep()

step attribute description:

The step in seconds between each selectable timestamp. The default value is 3,600 seconds (or 1 hour).

setStep

public void setStep(Integer step)

step attribute description:

The step in seconds between each selectable timestamp. The default value is 3,600 seconds (or 1 hour).

getStyleClass

public String getStyleClass()

styleClass attribute description:

List of CSS class names (separated by spaces) that are to be rendered within the class attribute.

Specified by:

getStyleClass in interface com.liferay.faces.util.component.Styleable

Overrides:

getStyleClass in class InputDateTimeBase