Skip navigation links

oracle.adf.view.rich.component
Class PartialUIXInputPopup

java.lang.Object
javax.faces.component.UIComponent
org.apache.myfaces.trinidad.component.UIXComponent
org.apache.myfaces.trinidad.component.UIXComponentBase
org.apache.myfaces.trinidad.component.UIXValue
org.apache.myfaces.trinidad.component.UIXEditableValue
org.apache.myfaces.trinidad.component.UIXInput
oracle.adf.view.rich.component.PartialUIXInputPopup

All Implemented Interfaces:

EventListener, javax.faces.component.EditableValueHolder, javax.faces.component.PartialStateHolder, javax.faces.component.StateHolder, javax.faces.component.TransientStateHolder, javax.faces.component.ValueHolder, javax.faces.event.ComponentSystemEventListener, javax.faces.event.FacesListener, javax.faces.event.SystemEventListenerHolder

Direct Known Subclasses:

UIXInputPopup

public abstract class PartialUIXInputPopup

extends org.apache.myfaces.trinidad.component.UIXInput

The UIXInputPopup component is an abstraction for components that allow both input and selection from a list of possible values.

Events:

Type	Phases	Description
oracle.adf.view.rich.event.LaunchPopupEvent	Invoke Application	LaunchPopupEvent is delivered when a user's action on an input component results in the launching of a popup dialog. For example, clicking the search icon on the inputListOfValues component or the "Search..." entry at the bottom of the drop down panel of the inputComboboxListOfValues component or tabbing-out of either of the above components with a non null value set, and autoSumit set to "true" will result in the queueing and broadcasting of LaunchPopupEvent on the input*ListOfValues component.
oracle.adf.view.rich.event.ReturnPopupDataEvent	Invoke Application Apply Request Values	Deprecated, will be removed in the future release
oracle.adf.view.rich.event.ReturnPopupEvent	Invoke Application	The ReturnPopupEvent is delivered after the the popup/dialog data is packaged and returned.
javax.faces.event.ValueChangeEvent	Process Validations Apply Request Values	The valueChange event is delivered when the value attribute is changed.
org.apache.myfaces.trinidad.event.AttributeChangeEvent	Invoke Application Apply Request Values	Event delivered to describe an attribute change. Attribute change events are not delivered for any programmatic change to a property. They are only delivered when a renderer changes a property without the application's specific request. An example of an attribute change event might include the width of a column that supported client-side resizing.

Field Summary

static String	COMPONENT_FAMILY
static String	COMPONENT_TYPE
static org.apache.myfaces.trinidad.bean.PropertyKey	CREATE_POPUP_ID_KEY
static String	EDIT_MODE_INPUT
static org.apache.myfaces.trinidad.bean.PropertyKey	EDIT_MODE_KEY
static String	EDIT_MODE_SELECT
static org.apache.myfaces.trinidad.bean.PropertyKey	LAUNCH_POPUP_LISTENER_KEY
static org.apache.myfaces.trinidad.bean.PropertyKey	MODEL_KEY
static String	RESULTS_TABLE_COLUMN_STRETCHING_BLANK
static org.apache.myfaces.trinidad.bean.PropertyKey	RESULTS_TABLE_COLUMN_STRETCHING_KEY
static String	RESULTS_TABLE_COLUMN_STRETCHING_LAST
static String	RESULTS_TABLE_COLUMN_STRETCHING_NONE
static org.apache.myfaces.trinidad.bean.PropertyKey	RETURN_POPUP_DATA_LISTENER_KEY
static org.apache.myfaces.trinidad.bean.PropertyKey	RETURN_POPUP_DATA_VALUE_KEY
static org.apache.myfaces.trinidad.bean.PropertyKey	RETURN_POPUP_LISTENER_KEY
static org.apache.myfaces.trinidad.bean.FacesBean.Type	TYPE

Fields inherited from class org.apache.myfaces.trinidad.component.UIXEditableValue

CONVERSION_MESSAGE_ID, IMMEDIATE_KEY, LOCAL_VALUE_SET_KEY, REQUIRED_KEY, REQUIRED_MESSAGE_DETAIL_KEY, REQUIRED_MESSAGE_ID, SUBMITTED_VALUE_KEY, TRINIDAD_BEAN_VALIDATION_AVAILABLE, TRINIDAD_EMPTY_VALUES_AS_NULL_PARAM_NAME, VALID_KEY, VALIDATE_EMPTY_FIELDS_PARAM_NAME, VALIDATOR_KEY, VALIDATORS_KEY, VALUE_CHANGE_LISTENER_KEY

Fields inherited from class org.apache.myfaces.trinidad.component.UIXValue

CONVERTER_KEY, VALUE_KEY

Fields inherited from class org.apache.myfaces.trinidad.component.UIXComponentBase

BINDING_KEY, ID_KEY, RENDERED_KEY, RENDERER_TYPE_KEY, TRANSIENT_KEY

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

protected

PartialUIXInputPopup(String rendererType) Construct an instance of the PartialUIXInputPopup.

Method Summary

void	addLaunchPopupListener(LaunchPopupListener listener) Adds a launchPopup listener.
void	addReturnPopupDataListener(ReturnPopupDataListener listener) Adds a returnPopupData listener.
void	addReturnPopupListener(ReturnPopupListener listener) Adds a returnPopup listener.
protected org.apache.myfaces.trinidad.bean.FacesBean.Type	getBeanType()
String	getCreatePopupId() Gets the id of the user-defined popup component relative to this component (accounting for NamingContainers).
String	getEditMode() Gets the mode that controls how the user specifies a value.
String	getFamily()
javax.el.MethodExpression	getLaunchPopupListener() Gets a method reference to a LaunchPopupListener (called in response to a LaunchPopupEvent).
LaunchPopupListener[]	getLaunchPopupListeners() Returns an array of attached launchPopup listeners.
ListOfValuesModel	getModel() Gets A ListOfValuesModel object that represents the model for the LOV component.
String	getResultsTableColumnStretching() Gets Indicates what kind of stretching you want applied to the columns of results table in search and select dialog.The default value is last which stretches the last column to fill up any unused space.If you want to have an empty blank column be automatically inserted and have it stretch (so the row background colors will span the entire width of the table), use the "blank" option.
javax.el.MethodExpression	getReturnPopupDataListener() Gets A method reference to a ReturnPopupDataListener (called in response to a ReturnPopupDataEvent).
ReturnPopupDataListener[]	getReturnPopupDataListeners() Returns an array of attached returnPopupData listeners.
Object	getReturnPopupDataValue() Gets an attribute for returning the set value in custom popup by the user in listOfValues component.
javax.el.MethodExpression	getReturnPopupListener() Gets a method reference to a ReturnPopupListener (called in response to a ReturnPopupEvent).
ReturnPopupListener[]	getReturnPopupListeners() Returns an array of attached returnPopup listeners.
void	removeLaunchPopupListener(LaunchPopupListener listener) Removes a launchPopup listener.
void	removeReturnPopupDataListener(ReturnPopupDataListener listener) Removes a returnPopupData listener.
void	removeReturnPopupListener(ReturnPopupListener listener) Removes a returnPopup listener.
void	setCreatePopupId(String createPopupId) Sets the id of the user-defined popup component relative to this component (accounting for NamingContainers).
void	setEditMode(String editMode) Sets the mode that controls how the user specifies a value.
void	setLaunchPopupListener(javax.el.MethodExpression launchPopupListener) Sets a method reference to a LaunchPopupListener (called in response to a LaunchPopupEvent).
void	setModel(ListOfValuesModel model) Sets A ListOfValuesModel object that represents the model for the LOV component.
void	setResultsTableColumnStretching(String resultsTableColumnStretching) Sets Indicates what kind of stretching you want applied to the columns of results table in search and select dialog.The default value is last which stretches the last column to fill up any unused space.If you want to have an empty blank column be automatically inserted and have it stretch (so the row background colors will span the entire width of the table), use the "blank" option.
void	setReturnPopupDataListener(javax.el.MethodExpression returnPopupDataListener) Sets A method reference to a ReturnPopupDataListener (called in response to a ReturnPopupDataEvent).
void	setReturnPopupDataValue(Object returnPopupDataValue) Sets an attribute for returning the set value in custom popup by the user in listOfValues component.
void	setReturnPopupListener(javax.el.MethodExpression returnPopupListener) Sets a method reference to a ReturnPopupListener (called in response to a ReturnPopupEvent).

Methods inherited from class org.apache.myfaces.trinidad.component.UIXEditableValue

addValidator, addValueChangeListener, broadcast, compareValues, getConvertedValue, getRequiredMessageDetail, getRequiredMessageKey, getSubmittedValue, getValidator, getValidators, getValueChangeListener, getValueChangeListeners, isEmpty, isImmediate, isLocalValueSet, isRequired, isValid, processDecodes, processUpdates, processValidators, removeValidator, removeValueChangeListener, resetValue, setImmediate, setLocalValueSet, setRequired, setRequiredMessageDetail, setSubmittedValue, setValid, setValidator, setValueChangeListener, shouldInterpretEmptyStringSubmittedValuesAsNull, shouldValidateEmptyFields, updateModel, validate, validateValue

Methods inherited from class org.apache.myfaces.trinidad.component.UIXValue

getConverter, getLocalValue, getValue, setConverter, setValue

Methods inherited from class org.apache.myfaces.trinidad.component.UIXComponentBase

adaptMethodBinding, addAttributeChange, addAttributeChangeListener, addClientBehavior, addComponentChange, addComponentChange, addComponentChangeFilter, addFacesListener, broadcastToMethodBinding, broadcastToMethodExpression, clearInitialState, createFacesBean, decode, decodeChildren, decodeChildrenImpl, encodeBegin, encodeChildren, encodeEnd, findComponent, getAttributeChangeListener, getAttributeChangeListeners, getAttributes, getBooleanProperty, getChildCount, getChildren, getClientBehaviors, getClientId, getComponentChangeFilters, getContainerClientId, getDefaultEventName, getFacesBean, getFacesContext, getFacesListeners, getFacet, getFacetCount, getFacetNames, getFacets, getFacetsAndChildren, getId, getIntProperty, getLifecycleRenderer, getListenersForEventClass, getParent, getProperty, getPropertyKey, getRenderedFacetsAndChildren, getRenderer, getRendererType, getRendersChildren, getValueBinding, getValueExpression, initialStateMarked, invokeOnChildrenComponents, invokeOnComponent, invokeOnNamingContainerComponent, isRendered, isTransient, markInitialState, processRestoreState, processSaveState, queueEvent, removeAttributeChangeListener, removeComponentChangeFilter, removeFacesListener, restoreState, satisfiesPartialTrigger, saveState, setAttributeChangeListener, setAttributeChangeListener, setBooleanProperty, setId, setIntProperty, setParent, setProperty, setRendered, setRendererType, setTransient, setupFlattenedChildrenContext, setupFlattenedContext, setValueBinding, setValueExpression, subscribeToEvent, tearDownFlattenedChildrenContext, tearDownFlattenedContext, toString, unsubscribeFromEvent, updateChildren, updateChildrenImpl, validateChildren, validateChildrenImpl

Methods inherited from class org.apache.myfaces.trinidad.component.UIXComponent

addPartialTarget, clearCachedClientIds, clearCachedClientIds, encodeFlattenedChild, encodeFlattenedChildren, getLogicalParent, getLogicalParent, getStateHelper, getStateHelper, isVisitable, partialEncodeVisit, processFlattenedChildren, processFlattenedChildren, processFlattenedChildren, processFlattenedChildren, setPartialTarget, setupChildrenEncodingContext, setupChildrenVisitingContext, setupEncodingContext, setUpEncodingContext, setupVisitingContext, tearDownChildrenEncodingContext, tearDownChildrenVisitingContext, tearDownEncodingContext, tearDownVisitingContext, visitAllChildren, visitChildren, visitChildren, visitTree, visitTree

Methods inherited from class javax.faces.component.UIComponent

encodeAll, getClientId, getCompositeComponentParent, getContainerClientId, getCurrentComponent, getCurrentCompositeComponent, getNamingContainer, getResourceBundleMap, getTransientStateHelper, getTransientStateHelper, isCompositeComponent, isInView, popComponentFromEL, processEvent, pushComponentToEL, restoreTransientState, saveTransientState, setInView

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface javax.faces.component.ValueHolder

getConverter, getLocalValue, getValue, setConverter, setValue

Field Detail

EDIT_MODE_INPUT

public static final String EDIT_MODE_INPUT

See Also:

Constant Field Values

EDIT_MODE_SELECT

public static final String EDIT_MODE_SELECT

See Also:

Constant Field Values

RESULTS_TABLE_COLUMN_STRETCHING_LAST

public static final String RESULTS_TABLE_COLUMN_STRETCHING_LAST

See Also:

Constant Field Values

RESULTS_TABLE_COLUMN_STRETCHING_NONE

public static final String RESULTS_TABLE_COLUMN_STRETCHING_NONE

See Also:

Constant Field Values

RESULTS_TABLE_COLUMN_STRETCHING_BLANK

public static final String RESULTS_TABLE_COLUMN_STRETCHING_BLANK

See Also:

Constant Field Values

TYPE

public static final org.apache.myfaces.trinidad.bean.FacesBean.Type TYPE

LAUNCH_POPUP_LISTENER_KEY

public static final org.apache.myfaces.trinidad.bean.PropertyKey LAUNCH_POPUP_LISTENER_KEY

MODEL_KEY

public static final org.apache.myfaces.trinidad.bean.PropertyKey MODEL_KEY

RETURN_POPUP_LISTENER_KEY

public static final org.apache.myfaces.trinidad.bean.PropertyKey RETURN_POPUP_LISTENER_KEY

RETURN_POPUP_DATA_LISTENER_KEY

public static final org.apache.myfaces.trinidad.bean.PropertyKey RETURN_POPUP_DATA_LISTENER_KEY

RETURN_POPUP_DATA_VALUE_KEY

public static final org.apache.myfaces.trinidad.bean.PropertyKey RETURN_POPUP_DATA_VALUE_KEY

CREATE_POPUP_ID_KEY

public static final org.apache.myfaces.trinidad.bean.PropertyKey CREATE_POPUP_ID_KEY

EDIT_MODE_KEY

public static final org.apache.myfaces.trinidad.bean.PropertyKey EDIT_MODE_KEY

RESULTS_TABLE_COLUMN_STRETCHING_KEY

public static final org.apache.myfaces.trinidad.bean.PropertyKey RESULTS_TABLE_COLUMN_STRETCHING_KEY

COMPONENT_FAMILY

public static final String COMPONENT_FAMILY

See Also:

Constant Field Values

COMPONENT_TYPE

public static final String COMPONENT_TYPE

See Also:

Constant Field Values

Constructor Detail

PartialUIXInputPopup

protected PartialUIXInputPopup(String rendererType)

Construct an instance of the PartialUIXInputPopup.

Method Detail

getLaunchPopupListener

public final javax.el.MethodExpression getLaunchPopupListener()

Gets a method reference to a LaunchPopupListener (called in response to a LaunchPopupEvent).

Returns:

the new launchPopupListener value

setLaunchPopupListener

public final void setLaunchPopupListener(javax.el.MethodExpression launchPopupListener)

Sets a method reference to a LaunchPopupListener (called in response to a LaunchPopupEvent).

Parameters:

launchPopupListener - the new launchPopupListener value

getModel

public final ListOfValuesModel getModel()

Gets A ListOfValuesModel object that represents the model for the LOV component. The ListOfValuesModel currently provides methods for use within the LOV component and in addition, to retrieve a QueryModel and TableModel in order to display a table and/or a query component (which are then used to search and select a value for the LOV component). For details, please refer to the Javadocs for oracle.adf.view.rich.model.ListOfValuesModel

Returns:

the new model value

setModel

public final void setModel(ListOfValuesModel model)

Sets A ListOfValuesModel object that represents the model for the LOV component. The ListOfValuesModel currently provides methods for use within the LOV component and in addition, to retrieve a QueryModel and TableModel in order to display a table and/or a query component (which are then used to search and select a value for the LOV component). For details, please refer to the Javadocs for oracle.adf.view.rich.model.ListOfValuesModel

Parameters:

model - the new model value

getReturnPopupListener

public final javax.el.MethodExpression getReturnPopupListener()

Gets a method reference to a ReturnPopupListener (called in response to a ReturnPopupEvent).

Returns:

the new returnPopupListener value

setReturnPopupListener

public final void setReturnPopupListener(javax.el.MethodExpression returnPopupListener)

Sets a method reference to a ReturnPopupListener (called in response to a ReturnPopupEvent).

Parameters:

returnPopupListener - the new returnPopupListener value

getReturnPopupDataListener

public final javax.el.MethodExpression getReturnPopupDataListener()

Gets A method reference to a ReturnPopupDataListener (called in response to a ReturnPopupDataEvent).

Returns:

the new returnPopupDataListener value

setReturnPopupDataListener

public final void setReturnPopupDataListener(javax.el.MethodExpression returnPopupDataListener)

Sets A method reference to a ReturnPopupDataListener (called in response to a ReturnPopupDataEvent).

Parameters:

returnPopupDataListener - the new returnPopupDataListener value

getReturnPopupDataValue

public final Object getReturnPopupDataValue()

Gets an attribute for returning the set value in custom popup by the user in listOfValues component.

Returns:

the new returnPopupDataValue value

setReturnPopupDataValue

public final void setReturnPopupDataValue(Object returnPopupDataValue)

Sets an attribute for returning the set value in custom popup by the user in listOfValues component.

Parameters:

returnPopupDataValue - the new returnPopupDataValue value

getCreatePopupId

public final String getCreatePopupId()

Gets the id of the user-defined popup component relative to this component (accounting for NamingContainers). If this attribute is supplied, an af:toolbar with a button will be created internally, which will be displayed as create icon in the Search and Select dialog. Clicking the button launches the user-defined popup component.
If the developer has added a dialog within the popup, then the decision to refresh the table is made by the component intelligently(table will be refreshed on pressing Ok button in the dialog). If the developer has not added a dialog to the popup, then the table will be refreshed always.
Identifiers are relative to the component, and must account for NamingContainers. You can use a single colon to start the search from the root, or multiple colons to move up through the NamingContainers - "::" will pop out of the component's naming container and begin the search from there, ":::" will pop out of two naming containers and begin the search from there, etc.

Returns:

the new createPopupId value

setCreatePopupId

public final void setCreatePopupId(String createPopupId)

Sets the id of the user-defined popup component relative to this component (accounting for NamingContainers). If this attribute is supplied, an af:toolbar with a button will be created internally, which will be displayed as create icon in the Search and Select dialog. Clicking the button launches the user-defined popup component.
If the developer has added a dialog within the popup, then the decision to refresh the table is made by the component intelligently(table will be refreshed on pressing Ok button in the dialog). If the developer has not added a dialog to the popup, then the table will be refreshed always.
Identifiers are relative to the component, and must account for NamingContainers. You can use a single colon to start the search from the root, or multiple colons to move up through the NamingContainers - "::" will pop out of the component's naming container and begin the search from there, ":::" will pop out of two naming containers and begin the search from there, etc.

Parameters:

createPopupId - the new createPopupId value

getEditMode

public final String getEditMode()

Gets the mode that controls how the user specifies a value. This attribute is only applicable when the 'readOnly' attribute is set to false.

• input: this mode allows the user to type in a value as well as browse and select from a list of available values.
• select: this mode allows the user only to browse and select from a list of available values.

Returns:

the new editMode value

setEditMode

public final void setEditMode(String editMode)

Sets the mode that controls how the user specifies a value. This attribute is only applicable when the 'readOnly' attribute is set to false.

• input: this mode allows the user to type in a value as well as browse and select from a list of available values.
• select: this mode allows the user only to browse and select from a list of available values.

Parameters:

editMode - the new editMode value

getResultsTableColumnStretching

public final String getResultsTableColumnStretching()

Gets Indicates what kind of stretching you want applied to the columns of results table in search and select dialog.The default value is last which stretches the last column to fill up any unused space.If you want to have an empty blank column be automatically inserted and have it stretch (so the row background colors will span the entire width of the table), use the "blank" option. Note that row headers and frozen columns will not be stretched because doing so could easily leave the user unable to access the scrollable data body of the table.

Returns:

the new resultsTableColumnStretching value

setResultsTableColumnStretching

public final void setResultsTableColumnStretching(String resultsTableColumnStretching)

Sets Indicates what kind of stretching you want applied to the columns of results table in search and select dialog.The default value is last which stretches the last column to fill up any unused space.If you want to have an empty blank column be automatically inserted and have it stretch (so the row background colors will span the entire width of the table), use the "blank" option. Note that row headers and frozen columns will not be stretched because doing so could easily leave the user unable to access the scrollable data body of the table.

Parameters:

resultsTableColumnStretching - the new resultsTableColumnStretching value

addLaunchPopupListener

public final void addLaunchPopupListener(LaunchPopupListener listener)

Adds a launchPopup listener.

Parameters:

listener - the launchPopup listener to add

removeLaunchPopupListener

public final void removeLaunchPopupListener(LaunchPopupListener listener)

Removes a launchPopup listener.

Parameters:

listener - the launchPopup listener to remove

getLaunchPopupListeners

public final LaunchPopupListener[] getLaunchPopupListeners()

Returns an array of attached launchPopup listeners.

Returns:

an array of attached launchPopup listeners.

addReturnPopupDataListener

public final void addReturnPopupDataListener(ReturnPopupDataListener listener)

Adds a returnPopupData listener.

Parameters:

listener - the returnPopupData listener to add

removeReturnPopupDataListener

public final void removeReturnPopupDataListener(ReturnPopupDataListener listener)

Removes a returnPopupData listener.

Parameters:

listener - the returnPopupData listener to remove

getReturnPopupDataListeners

public final ReturnPopupDataListener[] getReturnPopupDataListeners()

Returns an array of attached returnPopupData listeners.

Returns:

an array of attached returnPopupData listeners.

addReturnPopupListener

public final void addReturnPopupListener(ReturnPopupListener listener)

Adds a returnPopup listener.

Parameters:

listener - the returnPopup listener to add

removeReturnPopupListener

public final void removeReturnPopupListener(ReturnPopupListener listener)

Removes a returnPopup listener.

Parameters:

listener - the returnPopup listener to remove

getReturnPopupListeners

public final ReturnPopupListener[] getReturnPopupListeners()

Returns an array of attached returnPopup listeners.

Returns:

an array of attached returnPopup listeners.

getFamily

public String getFamily()

Overrides:

getFamily in class org.apache.myfaces.trinidad.component.UIXInput

getBeanType

protected org.apache.myfaces.trinidad.bean.FacesBean.Type getBeanType()

Overrides:

getBeanType in class org.apache.myfaces.trinidad.component.UIXInput

Skip navigation links