@Generated(value={"RichFaces CDK","4.5.0-SNAPSHOT"}) public class UIInplaceInput extends AbstractInplaceInput implements javax.faces.component.behavior.ClientBehaviorHolder, InplaceComponent, CoreProps, DisabledProps, EventsKeyProps, EventsMouseProps, FocusProps
The <rich:inplaceInput> component allows information to be entered in-line in blocks of text, improving readability of the text. Multiple input regions can be navigated with keyboard navigation. The component has three functional states: the view state, where the component displays its initial setting, such as "click to edit"; the edit state, where the user can input text; and the "changed" state, where the new value for the component has been confirmed but can be edited again if required.
Modifier and Type | Class and Description |
---|---|
protected static class |
UIInplaceInput.Properties |
Modifier and Type | Field and Description |
---|---|
static String |
COMPONENT_FAMILY |
static String |
COMPONENT_TYPE |
Constructor and Description |
---|
UIInplaceInput() |
Modifier and Type | Method and Description |
---|---|
String |
getActiveClass()
Space-separated list of CSS style class(es) to be applied when this element is active.
|
String |
getChangedClass()
Space-separated list of CSS style class(es) to be applied when the value of this element is changed.
|
String |
getDefaultEventName() |
String |
getDefaultLabel()
Used to set the display text when value is undefined
|
String |
getDisabledClass()
Space-separated list of CSS style class(es) to be applied when this element is rendered.
|
String |
getEditEvent()
Used to specify the event that switches the component to the edit state
|
Collection<String> |
getEventNames() |
String |
getFamily() |
String |
getInputWidth()
The width of the input element
|
String |
getOnblur()
Javascript code executed when this element loses focus.
|
String |
getOnchange()
Javascript code executed when this element loses focus and its value has been modified since gaining focus.
|
String |
getOnclick()
Javascript code executed when a pointer button is clicked over this element.
|
String |
getOndblclick()
Javascript code executed when a pointer button is double clicked over this element.
|
String |
getOnfocus()
Javascript code executed when this element receives focus.
|
String |
getOninputclick()
The client-side script method to be called when
|
String |
getOninputdblclick()
The client-side script method to be called when
|
String |
getOninputkeydown()
The client-side script method to be called when
|
String |
getOninputkeypress()
The client-side script method to be called when
|
String |
getOninputkeyup()
The client-side script method to be called when
|
String |
getOninputmousedown()
The client-side script method to be called when
|
String |
getOninputmousemove()
The client-side script method to be called when
|
String |
getOninputmouseout()
The client-side script method to be called when
|
String |
getOninputmouseover()
The client-side script method to be called when
|
String |
getOninputmouseup()
The client-side script method to be called when
|
String |
getOninputselect()
The client-side script method to be called when
|
String |
getOnkeydown()
Javascript code executed when a key is pressed down over this element.
|
String |
getOnkeypress()
Javascript code executed when a key is pressed and released over this element.
|
String |
getOnkeyup()
Javascript code executed when a key is released over this element.
|
String |
getOnmousedown()
Javascript code executed when a pointer button is pressed down over this element.
|
String |
getOnmousemove()
Javascript code executed when a pointer button is moved within this element.
|
String |
getOnmouseout()
Javascript code executed when a pointer button is moved away from this element.
|
String |
getOnmouseover()
Javascript code executed when a pointer button is moved onto this element.
|
String |
getOnmouseup()
Javascript code executed when a pointer button is released over this element.
|
InplaceState |
getState() |
String |
getStyle()
CSS style(s) to be applied when this component is rendered.
|
String |
getStyleClass()
Space-separated list of CSS style class(es) to be applied when this element is rendered.
|
String |
getTabindex()
Position of this element in the tabbing order for the current document.
|
String |
getTitle()
Advisory title information about markup elements generated for this component.
|
boolean |
isDisabled()
Flag indicating that this element must never receive focus or be included in a subsequent submit.
|
boolean |
isSaveOnBlur()
If "true", apply the changes when the focus is lost
|
boolean |
isShowControls()
If "true" is set, buttons for confirming or canceling are added to the component
|
void |
setActiveClass(String activeClass) |
void |
setChangedClass(String changedClass) |
void |
setDefaultLabel(String defaultLabel) |
void |
setDisabled(boolean disabled) |
void |
setDisabledClass(String disabledClass) |
void |
setEditEvent(String editEvent) |
void |
setInputWidth(String inputWidth) |
void |
setOnblur(String onblur) |
void |
setOnchange(String onchange) |
void |
setOnclick(String onclick) |
void |
setOndblclick(String ondblclick) |
void |
setOnfocus(String onfocus) |
void |
setOninputclick(String oninputclick) |
void |
setOninputdblclick(String oninputdblclick) |
void |
setOninputkeydown(String oninputkeydown) |
void |
setOninputkeypress(String oninputkeypress) |
void |
setOninputkeyup(String oninputkeyup) |
void |
setOninputmousedown(String oninputmousedown) |
void |
setOninputmousemove(String oninputmousemove) |
void |
setOninputmouseout(String oninputmouseout) |
void |
setOninputmouseover(String oninputmouseover) |
void |
setOninputmouseup(String oninputmouseup) |
void |
setOninputselect(String oninputselect) |
void |
setOnkeydown(String onkeydown) |
void |
setOnkeypress(String onkeypress) |
void |
setOnkeyup(String onkeyup) |
void |
setOnmousedown(String onmousedown) |
void |
setOnmousemove(String onmousemove) |
void |
setOnmouseout(String onmouseout) |
void |
setOnmouseover(String onmouseover) |
void |
setOnmouseup(String onmouseup) |
void |
setSaveOnBlur(boolean saveOnBlur) |
void |
setShowControls(boolean showControls) |
void |
setState(InplaceState state) |
void |
setStyle(String style) |
void |
setStyleClass(String styleClass) |
void |
setTabindex(String tabindex) |
void |
setTitle(String title) |
addValidator, addValueChangeListener, 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
getConverter, getLocalValue, setConverter
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
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
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
public static final String COMPONENT_TYPE
public static final String COMPONENT_FAMILY
public String getFamily()
getFamily
in class javax.faces.component.UIInput
public Collection<String> getEventNames()
getEventNames
in interface javax.faces.component.behavior.ClientBehaviorHolder
getEventNames
in class javax.faces.component.UIComponentBase
public String getDefaultEventName()
getDefaultEventName
in interface javax.faces.component.behavior.ClientBehaviorHolder
getDefaultEventName
in class javax.faces.component.UIComponentBase
public String getActiveClass()
AbstractInplaceInput
getActiveClass
in interface InplaceComponent
getActiveClass
in class AbstractInplaceInput
public void setActiveClass(String activeClass)
public String getChangedClass()
AbstractInplaceInput
getChangedClass
in interface InplaceComponent
getChangedClass
in class AbstractInplaceInput
public void setChangedClass(String changedClass)
public String getDefaultLabel()
AbstractInplaceInput
getDefaultLabel
in interface InplaceComponent
getDefaultLabel
in class AbstractInplaceInput
public void setDefaultLabel(String defaultLabel)
setDefaultLabel
in interface InplaceComponent
public boolean isDisabled()
DisabledProps
isDisabled
in interface DisabledProps
isDisabled
in interface InplaceComponent
public void setDisabled(boolean disabled)
public String getDisabledClass()
AbstractInplaceInput
getDisabledClass
in interface InplaceComponent
getDisabledClass
in class AbstractInplaceInput
public void setDisabledClass(String disabledClass)
public String getEditEvent()
AbstractInplaceInput
Used to specify the event that switches the component to the edit state
Default is "click"
getEditEvent
in interface InplaceComponent
getEditEvent
in class AbstractInplaceInput
public void setEditEvent(String editEvent)
public String getInputWidth()
AbstractInplaceInput
getInputWidth
in class AbstractInplaceInput
public void setInputWidth(String inputWidth)
public String getOnblur()
FocusProps
getOnblur
in interface FocusProps
public void setOnblur(String onblur)
public String getOnchange()
AbstractInplaceInput
getOnchange
in class AbstractInplaceInput
public void setOnchange(String onchange)
public String getOnclick()
EventsMouseProps
getOnclick
in interface EventsMouseProps
public void setOnclick(String onclick)
public String getOndblclick()
EventsMouseProps
getOndblclick
in interface EventsMouseProps
public void setOndblclick(String ondblclick)
public String getOnfocus()
FocusProps
getOnfocus
in interface FocusProps
public void setOnfocus(String onfocus)
public String getOninputclick()
AbstractInplaceInput
getOninputclick
in class AbstractInplaceInput
public void setOninputclick(String oninputclick)
public String getOninputdblclick()
AbstractInplaceInput
getOninputdblclick
in class AbstractInplaceInput
public void setOninputdblclick(String oninputdblclick)
public String getOninputkeydown()
AbstractInplaceInput
getOninputkeydown
in class AbstractInplaceInput
public void setOninputkeydown(String oninputkeydown)
public String getOninputkeypress()
AbstractInplaceInput
getOninputkeypress
in class AbstractInplaceInput
public void setOninputkeypress(String oninputkeypress)
public String getOninputkeyup()
AbstractInplaceInput
getOninputkeyup
in class AbstractInplaceInput
public void setOninputkeyup(String oninputkeyup)
public String getOninputmousedown()
AbstractInplaceInput
getOninputmousedown
in class AbstractInplaceInput
public void setOninputmousedown(String oninputmousedown)
public String getOninputmousemove()
AbstractInplaceInput
getOninputmousemove
in class AbstractInplaceInput
public void setOninputmousemove(String oninputmousemove)
public String getOninputmouseout()
AbstractInplaceInput
getOninputmouseout
in class AbstractInplaceInput
public void setOninputmouseout(String oninputmouseout)
public String getOninputmouseover()
AbstractInplaceInput
getOninputmouseover
in class AbstractInplaceInput
public void setOninputmouseover(String oninputmouseover)
public String getOninputmouseup()
AbstractInplaceInput
getOninputmouseup
in class AbstractInplaceInput
public void setOninputmouseup(String oninputmouseup)
public String getOninputselect()
AbstractInplaceInput
getOninputselect
in class AbstractInplaceInput
public void setOninputselect(String oninputselect)
public String getOnkeydown()
EventsKeyProps
getOnkeydown
in interface EventsKeyProps
public void setOnkeydown(String onkeydown)
public String getOnkeypress()
EventsKeyProps
getOnkeypress
in interface EventsKeyProps
public void setOnkeypress(String onkeypress)
public String getOnkeyup()
EventsKeyProps
getOnkeyup
in interface EventsKeyProps
public void setOnkeyup(String onkeyup)
public String getOnmousedown()
EventsMouseProps
getOnmousedown
in interface EventsMouseProps
public void setOnmousedown(String onmousedown)
public String getOnmousemove()
EventsMouseProps
getOnmousemove
in interface EventsMouseProps
public void setOnmousemove(String onmousemove)
public String getOnmouseout()
EventsMouseProps
getOnmouseout
in interface EventsMouseProps
public void setOnmouseout(String onmouseout)
public String getOnmouseover()
EventsMouseProps
getOnmouseover
in interface EventsMouseProps
public void setOnmouseover(String onmouseover)
public String getOnmouseup()
EventsMouseProps
getOnmouseup
in interface EventsMouseProps
public void setOnmouseup(String onmouseup)
public boolean isSaveOnBlur()
AbstractInplaceInput
isSaveOnBlur
in interface InplaceComponent
isSaveOnBlur
in class AbstractInplaceInput
public void setSaveOnBlur(boolean saveOnBlur)
public boolean isShowControls()
AbstractInplaceInput
isShowControls
in interface InplaceComponent
isShowControls
in class AbstractInplaceInput
public void setShowControls(boolean showControls)
public InplaceState getState()
getState
in interface InplaceComponent
getState
in class AbstractInplaceInput
public void setState(InplaceState state)
public String getStyle()
CoreProps
public void setStyle(String style)
public String getStyleClass()
CoreProps
getStyleClass
in interface CoreProps
public void setStyleClass(String styleClass)
public String getTabindex()
FocusProps
getTabindex
in interface FocusProps
getTabindex
in interface InplaceComponent
public void setTabindex(String tabindex)
public String getTitle()
CoreProps
public void setTitle(String title)
Copyright © 2015 JBoss by Red Hat. All Rights Reserved.