|
RichFaces UI Components UI 4.3.0.CR1 | |||||||||
| 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
org.richfaces.component.AbstractInplaceInput
org.richfaces.component.UIInplaceInput
@Generated(value={"RichFaces CDK","4.3.0.CR1"})
public class UIInplaceInput
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.
| Nested Class Summary | |
|---|---|
protected static class |
UIInplaceInput.Properties
|
| Field Summary | |
|---|---|
static String |
COMPONENT_FAMILY
|
static String |
COMPONENT_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 |
| Constructor Summary | |
|---|---|
UIInplaceInput()
|
|
| Method Summary | |
|---|---|
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()
|
String |
getOnchange()
Javascript code executed when this element loses focus and its value has been modified since gaining focus. |
String |
getOnclick()
|
String |
getOndblclick()
|
String |
getOnfocus()
|
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()
|
String |
getOnkeypress()
|
String |
getOnkeyup()
|
String |
getOnmousedown()
|
String |
getOnmousemove()
|
String |
getOnmouseout()
|
String |
getOnmouseover()
|
String |
getOnmouseup()
|
org.richfaces.component.InplaceState |
getState()
|
String |
getStyle()
|
String |
getStyleClass()
|
String |
getTabindex()
|
String |
getTitle()
|
boolean |
isDisabled()
If "true", this component is disabled |
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(org.richfaces.component.InplaceState state)
|
void |
setStyle(String style)
|
void |
setStyleClass(String styleClass)
|
void |
setTabindex(String tabindex)
|
void |
setTitle(String title)
|
| Methods inherited from class javax.faces.component.UIInput |
|---|
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, validateValue |
| Methods inherited from class javax.faces.component.UIOutput |
|---|
getConverter, getLocalValue, getValue, 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, 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, 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 String COMPONENT_TYPE
public static final String COMPONENT_FAMILY
| Constructor Detail |
|---|
public UIInplaceInput()
| Method Detail |
|---|
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()
AbstractInplaceInput
getActiveClass in interface org.richfaces.component.InplaceComponentgetActiveClass in class AbstractInplaceInputpublic void setActiveClass(String activeClass)
public String getChangedClass()
AbstractInplaceInput
getChangedClass in interface org.richfaces.component.InplaceComponentgetChangedClass in class AbstractInplaceInputpublic void setChangedClass(String changedClass)
public String getDefaultLabel()
AbstractInplaceInput
getDefaultLabel in interface org.richfaces.component.InplaceComponentgetDefaultLabel in class AbstractInplaceInputpublic void setDefaultLabel(String defaultLabel)
setDefaultLabel in interface org.richfaces.component.InplaceComponentpublic boolean isDisabled()
AbstractInplaceInput
isDisabled in interface org.richfaces.component.InplaceComponentisDisabled in class AbstractInplaceInputpublic void setDisabled(boolean disabled)
public String getDisabledClass()
AbstractInplaceInput
getDisabledClass in interface org.richfaces.component.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 org.richfaces.component.InplaceComponentgetEditEvent in class AbstractInplaceInputpublic void setEditEvent(String editEvent)
public String getInputWidth()
AbstractInplaceInput
getInputWidth in class AbstractInplaceInputpublic void setInputWidth(String inputWidth)
public String getOnblur()
getOnblur in class AbstractInplaceInputpublic void setOnblur(String onblur)
public String getOnchange()
AbstractInplaceInput
getOnchange in class AbstractInplaceInputpublic void setOnchange(String onchange)
public String getOnclick()
getOnclick in class AbstractInplaceInputpublic void setOnclick(String onclick)
public String getOndblclick()
getOndblclick in class AbstractInplaceInputpublic void setOndblclick(String ondblclick)
public String getOnfocus()
getOnfocus in class AbstractInplaceInputpublic void setOnfocus(String onfocus)
public String getOninputclick()
AbstractInplaceInput
getOninputclick in class AbstractInplaceInputpublic void setOninputclick(String oninputclick)
public String getOninputdblclick()
AbstractInplaceInput
getOninputdblclick in class AbstractInplaceInputpublic void setOninputdblclick(String oninputdblclick)
public String getOninputkeydown()
AbstractInplaceInput
getOninputkeydown in class AbstractInplaceInputpublic void setOninputkeydown(String oninputkeydown)
public String getOninputkeypress()
AbstractInplaceInput
getOninputkeypress in class AbstractInplaceInputpublic void setOninputkeypress(String oninputkeypress)
public String getOninputkeyup()
AbstractInplaceInput
getOninputkeyup in class AbstractInplaceInputpublic void setOninputkeyup(String oninputkeyup)
public String getOninputmousedown()
AbstractInplaceInput
getOninputmousedown in class AbstractInplaceInputpublic void setOninputmousedown(String oninputmousedown)
public String getOninputmousemove()
AbstractInplaceInput
getOninputmousemove in class AbstractInplaceInputpublic void setOninputmousemove(String oninputmousemove)
public String getOninputmouseout()
AbstractInplaceInput
getOninputmouseout in class AbstractInplaceInputpublic void setOninputmouseout(String oninputmouseout)
public String getOninputmouseover()
AbstractInplaceInput
getOninputmouseover in class AbstractInplaceInputpublic void setOninputmouseover(String oninputmouseover)
public String getOninputmouseup()
AbstractInplaceInput
getOninputmouseup in class AbstractInplaceInputpublic void setOninputmouseup(String oninputmouseup)
public String getOninputselect()
AbstractInplaceInput
getOninputselect in class AbstractInplaceInputpublic void setOninputselect(String oninputselect)
public String getOnkeydown()
getOnkeydown in class AbstractInplaceInputpublic void setOnkeydown(String onkeydown)
public String getOnkeypress()
getOnkeypress in class AbstractInplaceInputpublic void setOnkeypress(String onkeypress)
public String getOnkeyup()
getOnkeyup in class AbstractInplaceInputpublic void setOnkeyup(String onkeyup)
public String getOnmousedown()
getOnmousedown in class AbstractInplaceInputpublic void setOnmousedown(String onmousedown)
public String getOnmousemove()
getOnmousemove in class AbstractInplaceInputpublic void setOnmousemove(String onmousemove)
public String getOnmouseout()
getOnmouseout in class AbstractInplaceInputpublic void setOnmouseout(String onmouseout)
public String getOnmouseover()
getOnmouseover in class AbstractInplaceInputpublic void setOnmouseover(String onmouseover)
public String getOnmouseup()
getOnmouseup in class AbstractInplaceInputpublic void setOnmouseup(String onmouseup)
public boolean isSaveOnBlur()
AbstractInplaceInput
isSaveOnBlur in interface org.richfaces.component.InplaceComponentisSaveOnBlur in class AbstractInplaceInputpublic void setSaveOnBlur(boolean saveOnBlur)
public boolean isShowControls()
AbstractInplaceInput
isShowControls in interface org.richfaces.component.InplaceComponentisShowControls in class AbstractInplaceInputpublic void setShowControls(boolean showControls)
public org.richfaces.component.InplaceState getState()
getState in interface org.richfaces.component.InplaceComponentgetState in class AbstractInplaceInputpublic void setState(org.richfaces.component.InplaceState state)
public String getStyle()
public void setStyle(String style)
public String getStyleClass()
public void setStyleClass(String styleClass)
public String getTabindex()
getTabindex in interface org.richfaces.component.InplaceComponentgetTabindex in class AbstractInplaceInputpublic void setTabindex(String tabindex)
public String getTitle()
public void setTitle(String title)
|
RichFaces UI Components UI 4.3.0.CR1 | |||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||