@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()
Defines whether the changes should apply 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, 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, validateValuegetConverter, getLocalValue, getValue, setConverteraddClientBehavior, addFacesListener, broadcast, encodeBegin, encodeChildren, encodeEnd, findComponent, getAttributes, getChildCount, getChildren, getClientBehaviors, getClientId, getFacesContext, getFacesListeners, getFacet, getFacetCount, getFacets, getFacetsAndChildren, getId, getListenersForEventClass, getParent, getRenderer, getRendererType, getRendersChildren, getValueBinding, invokeOnComponent, isRendered, isTransient, processRestoreState, processSaveState, queueEvent, removeFacesListener, restoreAttachedState, saveAttachedState, setId, setParent, setRendered, setRendererType, setTransient, setValueBinding, subscribeToEvent, unsubscribeFromEventencodeAll, getClientId, getCompositeComponentParent, getContainerClientId, getCurrentComponent, getCurrentCompositeComponent, getNamingContainer, getResourceBundleMap, getStateHelper, getStateHelper, getTransientStateHelper, getTransientStateHelper, getValueExpression, initialStateMarked, isCompositeComponent, isInView, isVisitable, popComponentFromEL, processEvent, pushComponentToEL, restoreTransientState, saveTransientState, setInView, setValueExpression, visitTreeclone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitpublic static final String COMPONENT_TYPE
public static final String COMPONENT_FAMILY
public String getFamily()
getFamily in class javax.faces.component.UIInputpublic Collection<String> getEventNames()
getEventNames in interface javax.faces.component.behavior.ClientBehaviorHoldergetEventNames in class javax.faces.component.UIComponentBasepublic String getDefaultEventName()
getDefaultEventName in interface javax.faces.component.behavior.ClientBehaviorHoldergetDefaultEventName in class javax.faces.component.UIComponentBasepublic String getActiveClass()
AbstractInplaceInputgetActiveClass in interface InplaceComponentgetActiveClass in class AbstractInplaceInputpublic void setActiveClass(String activeClass)
public String getChangedClass()
AbstractInplaceInputgetChangedClass in interface InplaceComponentgetChangedClass in class AbstractInplaceInputpublic void setChangedClass(String changedClass)
public String getDefaultLabel()
AbstractInplaceInputgetDefaultLabel in interface InplaceComponentgetDefaultLabel in class AbstractInplaceInputpublic void setDefaultLabel(String defaultLabel)
setDefaultLabel in interface InplaceComponentpublic boolean isDisabled()
DisabledPropsisDisabled in interface DisabledPropsisDisabled in interface InplaceComponentpublic void setDisabled(boolean disabled)
public String getDisabledClass()
AbstractInplaceInputgetDisabledClass in interface InplaceComponentgetDisabledClass in class AbstractInplaceInputpublic void setDisabledClass(String disabledClass)
public String getEditEvent()
AbstractInplaceInputUsed to specify the event that switches the component to the edit state
Default is "click"
getEditEvent in interface InplaceComponentgetEditEvent in class AbstractInplaceInputpublic void setEditEvent(String editEvent)
public String getInputWidth()
AbstractInplaceInputgetInputWidth in class AbstractInplaceInputpublic void setInputWidth(String inputWidth)
public String getOnblur()
FocusPropsgetOnblur in interface FocusPropspublic void setOnblur(String onblur)
public String getOnchange()
AbstractInplaceInputgetOnchange in class AbstractInplaceInputpublic void setOnchange(String onchange)
public String getOnclick()
EventsMousePropsgetOnclick in interface EventsMousePropspublic void setOnclick(String onclick)
public String getOndblclick()
EventsMousePropsgetOndblclick in interface EventsMousePropspublic void setOndblclick(String ondblclick)
public String getOnfocus()
FocusPropsgetOnfocus in interface FocusPropspublic void setOnfocus(String onfocus)
public String getOninputclick()
AbstractInplaceInputgetOninputclick in class AbstractInplaceInputpublic void setOninputclick(String oninputclick)
public String getOninputdblclick()
AbstractInplaceInputgetOninputdblclick in class AbstractInplaceInputpublic void setOninputdblclick(String oninputdblclick)
public String getOninputkeydown()
AbstractInplaceInputgetOninputkeydown in class AbstractInplaceInputpublic void setOninputkeydown(String oninputkeydown)
public String getOninputkeypress()
AbstractInplaceInputgetOninputkeypress in class AbstractInplaceInputpublic void setOninputkeypress(String oninputkeypress)
public String getOninputkeyup()
AbstractInplaceInputgetOninputkeyup in class AbstractInplaceInputpublic void setOninputkeyup(String oninputkeyup)
public String getOninputmousedown()
AbstractInplaceInputgetOninputmousedown in class AbstractInplaceInputpublic void setOninputmousedown(String oninputmousedown)
public String getOninputmousemove()
AbstractInplaceInputgetOninputmousemove in class AbstractInplaceInputpublic void setOninputmousemove(String oninputmousemove)
public String getOninputmouseout()
AbstractInplaceInputgetOninputmouseout in class AbstractInplaceInputpublic void setOninputmouseout(String oninputmouseout)
public String getOninputmouseover()
AbstractInplaceInputgetOninputmouseover in class AbstractInplaceInputpublic void setOninputmouseover(String oninputmouseover)
public String getOninputmouseup()
AbstractInplaceInputgetOninputmouseup in class AbstractInplaceInputpublic void setOninputmouseup(String oninputmouseup)
public String getOninputselect()
AbstractInplaceInputgetOninputselect in class AbstractInplaceInputpublic void setOninputselect(String oninputselect)
public String getOnkeydown()
EventsKeyPropsgetOnkeydown in interface EventsKeyPropspublic void setOnkeydown(String onkeydown)
public String getOnkeypress()
EventsKeyPropsgetOnkeypress in interface EventsKeyPropspublic void setOnkeypress(String onkeypress)
public String getOnkeyup()
EventsKeyPropsgetOnkeyup in interface EventsKeyPropspublic void setOnkeyup(String onkeyup)
public String getOnmousedown()
EventsMousePropsgetOnmousedown in interface EventsMousePropspublic void setOnmousedown(String onmousedown)
public String getOnmousemove()
EventsMousePropsgetOnmousemove in interface EventsMousePropspublic void setOnmousemove(String onmousemove)
public String getOnmouseout()
EventsMousePropsgetOnmouseout in interface EventsMousePropspublic void setOnmouseout(String onmouseout)
public String getOnmouseover()
EventsMousePropsgetOnmouseover in interface EventsMousePropspublic void setOnmouseover(String onmouseover)
public String getOnmouseup()
EventsMousePropsgetOnmouseup in interface EventsMousePropspublic void setOnmouseup(String onmouseup)
public boolean isSaveOnBlur()
AbstractInplaceInputisSaveOnBlur in interface InplaceComponentisSaveOnBlur in class AbstractInplaceInputpublic void setSaveOnBlur(boolean saveOnBlur)
public boolean isShowControls()
AbstractInplaceInputisShowControls in interface InplaceComponentisShowControls in class AbstractInplaceInputpublic void setShowControls(boolean showControls)
public InplaceState getState()
getState in interface InplaceComponentgetState in class AbstractInplaceInputpublic void setState(InplaceState state)
public String getStyle()
CorePropspublic void setStyle(String style)
public String getStyleClass()
CorePropsgetStyleClass in interface CorePropspublic void setStyleClass(String styleClass)
public String getTabindex()
FocusPropsgetTabindex in interface FocusPropsgetTabindex in interface InplaceComponentpublic void setTabindex(String tabindex)
public String getTitle()
CorePropspublic void setTitle(String title)
Copyright © 2015 JBoss by Red Hat. All Rights Reserved.