public abstract class IlvObjectSelectInteractor extends javax.faces.component.UIInput implements IlvFacesComponent, IlvFacesInteractor, IlvDHTMLConstants, IlvViewHelper
objectSelectedFinder
that will
set the value from the JViews Faces View and the parameters passed from the renderer.Modifier and Type | Field and Description |
---|---|
static Boolean |
AUTO_SUBMIT_DEFAULT_VALUE
Default value of
autoSubmit property |
static Integer |
INVOCATION_CONTEXT_DEFAULT_VALUE
Default value of invocationContext property (JSF_CONTEXT).
|
static Boolean |
PARTIAL_SUBMIT_DEFAULT_VALUE
Default value of
partialSubmit property. |
COMPONENT_FAMILY, COMPONENT_TYPE, CONVERSION_MESSAGE_ID, REQUIRED_MESSAGE_ID, UPDATE_MESSAGE_ID, VALIDATE_EMPTY_FIELDS_PARAM_NAME
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
ACCESSIBLE, ACTION_NAME, AUTO_SUBMIT, BACKGROUND_COLOR, CAPABILITIES_LOADED_HANDLER, COMPONENT, DO_ACTION_ON_BG_DESELECT, ERROR_MESSAGE, GENERATE_IMAGE_MAP, HOTKEYS, IMAGE_FORMAT, IMAGE_LOADED_HANDLER, IMAGE_MAP_GENERATOR, IMAGE_MAP_GENERATOR_CLASS, IMAGE_MAP_VISIBLE, IMAGE_SERVLET_CONTEXT, INVOCATION_CONTEXT, JSF_CONTEXT, ON_CLICK, ON_SELECTION_CHANGED, PARTIAL_SUBMIT, PORTLET_CONTEXT_KEY, PORTLET_SESSION_KEY, REPLACE_PATTERN, RESIZABLE, SELECTION_RESIZABLE_CLASS, SESSION_EXP_HANDLER, SUBMITTED_VALUE, WAITING_IMAGE
AFTER_HANDLER, BASETEXTDIRECTION, BEFORE_HANDLER, BUTTON_GROUP_ID, BUTTON_TYPE, CHARTS_BUNDLE, CHARTS_MESSAGE_BUNDLE, CORE_BUNDLE, CORE_MESSAGE_BUNDLE, CURSOR, DATA, DECODED_PROPERTY, DEFAULT_LINE_COLOR, DELETION_ALLOWED, DIAGRAMMER_BUNDLE, DIAGRAMMER_MESSAGE_BUNDLE, ENABLED, EVENT_TYPE, FILL_ON, FORCE_UPDATE_PROPERTIES, FRAMEWORK_BUNDLE, FRAMEWORK_MESSAGE_BUNDLE, GANTT_BUNDLE, GANTT_MESSAGE_BUNDLE, HEIGHT, IMAGE, IMAGE_MODE, INFO_PROVIDER_MB, INT_NOT_DEFINED, INTERACTORS, INTERCEPT_INTERACTOR, ITEM_DISABLED_STYLE_CLASS, ITEM_HIGHLIGHTED_STYLE_CLASS, ITEM_STYLE_CLASS, LINE_COLOR, LINE_WIDTH, MAPS_BUNDLE, MAPS_MESSAGE_BUNDLE, MENU_MODEL_ID, MESSAGE, MESSAGE_BOX, MESSAGE_BOX_ID, MOVE_ALLOWED, OBJECT_FINDER, PARAM_COMPID, PARAM_DATA, PARAM_KEY, PARAM_NAMESPACE, PARAM_RESOURCE, PARAM_SERVICE, PARAM_TYPE, POPUP_MENU, POPUP_MENU_FACTORY, POPUP_MENU_FACTORY_CLASS, PORTLET_NAMESPACE, PROGRESSIVE_ZOOM, PROJECT, RENDER, RESOURCES_PATH, RESOURCES_PATH_PREFIX, ROLLOVER_IMAGE, SCROLL_BAR, SELECTED, SELECTED_IMAGE, SERVICE_FORWARD, SERVICE_FORWARD_INT, SERVLET, SERVLET_CLASS, SERVLET_URL, STYLE, STYLE_CLASS, TGO_BUNDLE, TGO_MESSAGE_BUNDLE, TITLE, TOGGLE, VALUE, VIEW, VIEW_ID, WIDTH
Constructor and Description |
---|
IlvObjectSelectInteractor()
Creates a new
IlvObjectSelectInteractor instance. |
Modifier and Type | Method and Description |
---|---|
void |
broadcast(javax.faces.event.FacesEvent event) |
void |
clearDecodedPropertyMap()
Clears the decoded properties.
|
Map |
getAttributes()
Returns a mutable
Map representing the attributes
(and properties, see below) associated with this UIComponent ,
keyed by attribute name (which must be a String). |
String |
getCursor()
Returns the mouse
cursor to be displayed when using this interactor. |
protected abstract IlvObjectSelectedFinder |
getDefaultObjectSelectedFinder()
Returns the default
IlvObjectSelectedFinder instance if no specified instance is provided. |
int |
getInvocationContext()
Returns the invocation context of the
valueChangeListener . |
String |
getMenuModelId()
Sets the model ID used in menu generation.
|
String |
getMessage()
Returns the
message displayed by the message box attached to the view (if
any) to which this interactor is attached. |
IlvObjectSelectedFinder |
getObjectSelectedFinder()
Returns the object selected finder instance.
|
IlvBasicView |
getView()
Returns the view component associated with this component.
|
String |
getViewId()
Returns the ID of the view linked to this component.
|
boolean |
isAutoSubmit()
Returns the auto submit mode.
|
boolean |
isDecodedProperty(String property)
Returns
true if the specified property was decoded during the "Apply
Request Value" phase of the JSF lifecycle, false otherwise. |
boolean |
isPartialSubmit()
Returns the partial submit mode.
|
void |
resetDecodedProperties()
Resets the decoded properties of this component.
|
void |
restoreState(javax.faces.context.FacesContext context,
Object stateObj)
Restores the state of this component from the
state parameter. |
Object |
saveState(javax.faces.context.FacesContext context)
Returns the
state of this component. |
void |
setAutoSubmit(boolean autoSubmit)
Sets the auto submit mode.
|
void |
setCursor(String cursor)
Sets the mouse
cursor to be displayed when using this interactor. |
void |
setDecodedProperty(String property)
Sets the property to
decoded , which means that the property value was
updated from the request during the "Apply Request Value" phase of the JSF
life cycle. |
void |
setInvocationContext(int invocationContext)
Sets the invocation context of the
valueChangeListener . |
void |
setMenuModelId(String modelId)
Returns the model ID used in menu generation.
|
void |
setMessage(String message)
Sets the
message displayed when using this interactor. |
void |
setObjectSelectedFinder(IlvObjectSelectedFinder objectSelectFinder)
Sets the object selected finder instance.
|
void |
setPartialSubmit(boolean partialSubmit)
Sets the partial submit mode.
|
void |
setView(IlvBasicView view)
Sets the view component associated with this component.
|
void |
setViewId(String viewId)
Sets the ID of the view linked to this component.
|
void |
updateModel(javax.faces.context.FacesContext context)
This method updates the referenced values with the local values of the
component if these values were updated from the client.
|
void |
validate(javax.faces.context.FacesContext context)
Overrides
UIInput.validate(FacesContext) to launch an event event if
UIInput.getSubmittedValue() returns null . |
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, setConverterMessage, setImmediate, setLocalValueSet, setRequired, setRequiredMessage, setSubmittedValue, setValid, setValidator, setValidatorMessage, setValue, setValueChangeListener, validateValue
getConverter, getLocalValue, setConverter
addClientBehavior, addFacesListener, encodeBegin, encodeChildren, encodeEnd, findComponent, getChildCount, getChildren, getClientBehaviors, getClientId, getDefaultEventName, getEventNames, 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
public static final Boolean AUTO_SUBMIT_DEFAULT_VALUE
autoSubmit
propertypublic static final Boolean PARTIAL_SUBMIT_DEFAULT_VALUE
partialSubmit
property.public static final Integer INVOCATION_CONTEXT_DEFAULT_VALUE
public IlvObjectSelectInteractor()
IlvObjectSelectInteractor
instance.public Map getAttributes()
Returns a mutable Map
representing the attributes
(and properties, see below) associated with this UIComponent
,
keyed by attribute name (which must be a String). The returned
implementation must support all of the standard and optional
Map
methods, plus support the following additional
requirements:
Map
implementation must implement
the java.io.Serializable
interface.null
key or value must
throw a NullPointerException
.ClassCastException
.UIComponent
's implementation class, the following
methods will have special behavior:
containsKey
- Return false
.get()
- If the property is readable, call
the getter method and return the returned value (wrapping
primitive values in their corresponding wrapper classes);
otherwise throw IllegalArgumentException
.put()
- If the property is writable, call
the setter method to set the corresponding value (unwrapping
primitive values in their corresponding wrapper classes).
If the property is not writeable, or an attempt is made to
set a property of primitive type to null
,
throw IllegalArgumentException
.remove
- Throw
IllegalArgumentException
.getAttributes
in class javax.faces.component.UIComponentBase
public boolean isAutoSubmit()
true
, this interactor will submit the
enclosing form on a click event. The auto submit mode is set to true
by
default.public boolean isPartialSubmit()
true
, the autoSubmit
is also true
and in a PPR environment this interactor will partially submit the
enclosing form on a click event.
The partial submit mode is set to false
by default.public void setAutoSubmit(boolean autoSubmit)
true
, this interactor will submit the
enclosing form on a click event.
The auto submit mode is set to true
by default.autoSubmit
- The auto submit to set.public void setPartialSubmit(boolean partialSubmit)
true
, the autoSubmit
is also true
and in a PPR environment this interactor will partially submit the
enclosing form on a click event.
The partial submit mode is set to false
by
default.partialSubmit
- The partial submit to set.public IlvBasicView getView()
getView
in interface IlvViewHelper
public String getViewId()
getViewId
in interface IlvViewHelper
public void setView(IlvBasicView view)
setView
in interface IlvViewHelper
view
- The view component associated with this component.public void setViewId(String viewId)
setViewId
in interface IlvViewHelper
viewId
- The ID of the view.public void clearDecodedPropertyMap()
clearDecodedPropertyMap
in interface IlvFacesComponent
public IlvObjectSelectedFinder getObjectSelectedFinder()
public void setObjectSelectedFinder(IlvObjectSelectedFinder objectSelectFinder)
objectSelectFinder
- The finder to attach to this interactor.public boolean isDecodedProperty(String property)
true
if the specified property was decoded during the "Apply
Request Value" phase of the JSF lifecycle, false
otherwise.isDecodedProperty
in interface IlvFacesComponent
property
- The property to test.true
if the property was decoded, false
otherwise.public void resetDecodedProperties()
resetDecodedProperties
in interface IlvFacesComponent
public void setDecodedProperty(String property)
decoded
, which means that the property value was
updated from the request during the "Apply Request Value" phase of the JSF
life cycle. This method must be called by renderers only during the execution of their decode
method.setDecodedProperty
in interface IlvFacesComponent
property
- The property to set to decoded
.public String getCursor()
cursor
to be displayed when using this interactor.getCursor
in interface IlvFacesInteractor
cursor
of the interactor.public String getMessage()
message
displayed by the message box attached to the view (if
any) to which this interactor is attached.getMessage
in interface IlvFacesInteractor
message
for this interactor.public void setCursor(String cursor)
cursor
to be displayed when using this interactor.
Valid values are the values supported by the target browsers.setCursor
in interface IlvFacesInteractor
cursor
- The cursor to set.public void setMessage(String message)
message
displayed when using this interactor. The message will be
displayed in the message box attached to the view, if any.setMessage
in interface IlvFacesInteractor
message
- The message
displayed when using this interactor.public int getInvocationContext()
valueChangeListener
.
IlvDHTMLConstants.JSF_CONTEXT
and
IlvDHTMLConstants.IMAGE_SERVLET_CONTEXT
:JSF_CONTEXT
: the value change listener is invoked in the JSF lifecycle.IMAGE_SERVLET_CONTEXT
: the value change listener is invoked in the image generating servlet, just before the image generation.
In this mode there are some limitations: you can only access to the graphic component that generates the image and not
on the JSF components that are not refreshed. Use the JSF_CONTEXT
mode in this case.public void setInvocationContext(int invocationContext)
valueChangeListener
.
IlvDHTMLConstants.JSF_CONTEXT
and
IlvDHTMLConstants.IMAGE_SERVLET_CONTEXT
:JSF_CONTEXT
: the value change listener is invoked in the JSF lifecycle.IMAGE_SERVLET_CONTEXT
: the value change listener is invoked in the image generating servlet, just before the image generation.
In this mode there are some limitations: you can only access to the graphic component that generates the image and not
on the JSF components that are not refreshed. Use the JSF_CONTEXT
mode in this case.invocationContext
- The invocation context.public String getMenuModelId()
getMenuModelId
in interface IlvFacesInteractor
public void setMenuModelId(String modelId)
setMenuModelId
in interface IlvFacesInteractor
modelId
- The model ID of this interactor.public void validate(javax.faces.context.FacesContext context)
UIInput.validate(FacesContext)
to launch an event event if
UIInput.getSubmittedValue()
returns null
.validate
in class javax.faces.component.UIInput
public void updateModel(javax.faces.context.FacesContext context)
updateModel
in interface IlvViewHelper
updateModel
in class javax.faces.component.UIInput
context
- The current faces context.public Object saveState(javax.faces.context.FacesContext context)
state
of this component.saveState
in interface IlvFacesComponent
saveState
in interface IlvViewHelper
saveState
in interface javax.faces.component.StateHolder
saveState
in class javax.faces.component.UIInput
context
- The current faces context.state
of this component.public void restoreState(javax.faces.context.FacesContext context, Object stateObj)
state
parameter.restoreState
in interface IlvFacesComponent
restoreState
in interface IlvViewHelper
restoreState
in interface javax.faces.component.StateHolder
restoreState
in class javax.faces.component.UIInput
context
- The current faces context.stateObj
- The previously saved state
of this component.protected abstract IlvObjectSelectedFinder getDefaultObjectSelectedFinder()
IlvObjectSelectedFinder
instance if no specified instance is provided.IlvObjectSelectedFinder
instance.public void broadcast(javax.faces.event.FacesEvent event) throws javax.faces.event.AbortProcessingException
broadcast
in class javax.faces.component.UIComponentBase
javax.faces.event.AbortProcessingException
UIComponentBase.broadcast(javax.faces.event.FacesEvent)
© Copyright Rogue Wave Software, Inc. 1997, 2018. All Rights Reserved.