|
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
org.richfaces.component.AbstractFocus
org.richfaces.component.UIFocus
@Generated(value={"RichFaces CDK","4.3.0.CR1"})
public class UIFocus
Focus component allows to set focus based on validation of components or alternatively it can preserve focus on currently focused form input.
Focus can be bound to form (in case of placement to h:form) or to whole view (when placed outside of forms) - in latter case, all forms will be managed by one Focus. There can be at most one Focus per form. When there is one view-scoped Focus and form defines own Focus, form-scoped Focus settings will be used.
Focus is applied each time the component is rendered - for each full page submit and for each partial page request (in case of ajaxRendered=true). Alternatively, you can use JavaScript API: applyFocus() function will immediately cause.
| Nested Class Summary | |
|---|---|
protected static class |
UIFocus.Properties
|
| Nested classes/interfaces inherited from class org.richfaces.component.AbstractFocus |
|---|
AbstractFocus.Mode |
| Field Summary | |
|---|---|
static String |
COMPONENT_FAMILY
|
static String |
COMPONENT_TYPE
|
| 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 | |
|---|---|
UIFocus()
|
|
| Method Summary | |
|---|---|
String |
getFamily()
|
boolean |
isAjaxRendered()
Defines whether focus state should be updated during each AJAX request automatically. |
boolean |
isDelayed()
Defines whether focus should not be applied after initial page load, but will need to be triggered by JavaScript function from Focus API: applyFocus() or via re-rendering (postback). |
boolean |
isKeepTransient()
Hide keepTransient attribute from AjaxOutput |
boolean |
isPreserve()
Defines whether focus should be preserved on last focused input before request was done (default: false) |
boolean |
isValidationAware()
Defines if focus should respect validation of inputs. |
void |
setAjaxRendered(boolean ajaxRendered)
|
void |
setDelayed(boolean delayed)
|
void |
setKeepTransient(boolean keepTransient)
|
void |
setPreserve(boolean preserve)
|
void |
setValidationAware(boolean validationAware)
|
| Methods inherited from class org.richfaces.component.AbstractFocus |
|---|
getMode, processEvent |
| Methods inherited from class javax.faces.component.UIOutput |
|---|
clearInitialState, getConverter, getLocalValue, getValue, markInitialState, restoreState, saveState, setConverter, setValue |
| Methods inherited from class javax.faces.component.UIComponentBase |
|---|
addClientBehavior, addFacesListener, broadcast, decode, encodeBegin, encodeChildren, encodeEnd, findComponent, getAttributes, getChildCount, getChildren, getClientBehaviors, getClientId, getDefaultEventName, getEventNames, getFacesContext, getFacesListeners, getFacet, getFacetCount, getFacets, getFacetsAndChildren, getId, getListenersForEventClass, getParent, getRenderer, getRendererType, getRendersChildren, getValueBinding, invokeOnComponent, isRendered, isTransient, processDecodes, processRestoreState, processSaveState, processUpdates, processValidators, 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, pushComponentToEL, restoreTransientState, saveTransientState, setInView, setValueExpression, visitTree |
| Methods inherited from class java.lang.Object |
|---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
| Field Detail |
|---|
public static final String COMPONENT_TYPE
public static final String COMPONENT_FAMILY
| Constructor Detail |
|---|
public UIFocus()
| Method Detail |
|---|
public String getFamily()
getFamily in class javax.faces.component.UIOutputpublic boolean isAjaxRendered()
AbstractFocus
isAjaxRendered in interface org.ajax4jsf.component.AjaxOutputisAjaxRendered in class AbstractFocuspublic void setAjaxRendered(boolean ajaxRendered)
setAjaxRendered in interface org.ajax4jsf.component.AjaxOutputpublic boolean isDelayed()
AbstractFocus
isDelayed in class AbstractFocuspublic void setDelayed(boolean delayed)
public boolean isKeepTransient()
AbstractFocus
isKeepTransient in interface org.ajax4jsf.component.AjaxOutputisKeepTransient in class AbstractFocuspublic void setKeepTransient(boolean keepTransient)
setKeepTransient in interface org.ajax4jsf.component.AjaxOutputpublic boolean isPreserve()
AbstractFocus
isPreserve in class AbstractFocuspublic void setPreserve(boolean preserve)
public boolean isValidationAware()
AbstractFocusDefines if focus should respect validation of inputs.
If true, only invalid form fields will be focused when focus applied.
(default: true)
isValidationAware in class AbstractFocuspublic void setValidationAware(boolean validationAware)
|
RichFaces UI Components UI 4.3.0.CR1 | |||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||