Skip navigation links

oracle.adf.view.rich.component.rich
Class RichQuery

java.lang.Object
javax.faces.component.UIComponent
org.apache.myfaces.trinidad.component.UIXComponent
org.apache.myfaces.trinidad.component.UIXComponentBase
oracle.adf.view.rich.component.PartialUIXQuery
oracle.adf.view.rich.component.UIXQuery
oracle.adf.view.rich.component.rich.RichQuery

All Implemented Interfaces:

EventListener, javax.faces.component.behavior.ClientBehaviorHolder, javax.faces.component.NamingContainer, javax.faces.component.PartialStateHolder, javax.faces.component.StateHolder, javax.faces.component.TransientStateHolder, javax.faces.event.ComponentSystemEventListener, javax.faces.event.FacesListener, javax.faces.event.SystemEventListenerHolder

public class RichQuery

extends UIXQuery

implements javax.faces.component.behavior.ClientBehaviorHolder, javax.faces.component.NamingContainer

The query component provides the user the ability to perform a query based on a saved search or personalize saved searches. The component displays a search panel with various elements, each of which help the user to accomplish various tasks.

To properly render the query panel when content width is more than view area, it should be wrapped in a af:panelGroupLayout with layout="horizontal". For ex:

  <af:panelGroupLayout layout="horizontal" inlineStyle="width:100%" >
     <af:query id="queryId" rows="3" headerText="Search" disclosed="true"
               model="#{demoQuery.queryModel}" queryListener="#{demoQuery.processQuery}"/>
  </af:panelGroupLayout>                       
           

Elements rendered by the query component

• Search Panel: the panel that encloses all elements rendered by the query component
• Search Header: Spans the entire width of the search panel and used to display a disclosure icon, the label, search mode (toggle button) and saved search (choice list of saved searches). The help (deprecated), info and toolbar facets' content is also displayed in the header.
• Match Type: A radio button group that appears below the search header, it defines whether the search criteria should be treated as an AND search or an OR search. For details on the conjunction operators refer to the QueryDescriptor and ConjunctionCriterion classes.
• Criteria region: A form layout that appears below the Match type, it contains search fields that define the search parameters. For details on search fields refer to the QueryDescriptor model.
• Criterion: A criterion represents a single search field, that comprises of an operator and one or more value fields. For value fields that render LOV components, the autoComplete feature is not enabled unless either of the methods, AttributeCriterion.hasDependentCriterion() or ListOfValuesModel.isAutoCompleteEnabled() return true. This is done to allow the end-user to enter partial values with wild-cards and tab around the search panel without causing the LOV dialog to be launched (everytime they tab-out of the LOV value field).
• Action buttons: The search panel has four action buttons: Search, Reset, Save, and Add Fields. The action buttons appear below the criteria region. They are end-aligned within the search header.
• NOTE: The Add Fields feature is only available in the Advanced mode.

Tasks performed using a query component

The following actions are performed on the currently selected saved search.

• Perform Search: Executes a query based on the search criteria (values entered for the search fields). Exposed as the Search button
• Add Criterion: Adds the selected attribute (represented by an AttributeDescriptor) as a criterion to the current saved search in the search panel (represented by a QueryDescriptor object). The query component by default registers an internal ActionListener for the associated ActionEvent and invokes the addCriterion method in the QueryDescriptor.
• Remove Criterion: Removes the search field (aka AttributeCriterion). The user can click the remove butcon that appears next to certain search fields. The query component by default registers an internal ActionListener for the ActionEvent that is fired as part of the delete and invokes the deleteCriterion method in the QueryDescriptor.
• Toggle Mode: Toggles the mode of the search panel between Basic and Advanced
• Change Conjunction: Changes the conjunction operator to be used when executing a query.

The following actions are performed on saved searches:

• Create: Create a new saved search based on the current search criteria used on the search panel. Exposed as the Save.. button on the Search panel.
• Reset: Resets the saved search to its default state. Exposed as the Reset button.
• Select: Saved searches (displayed in a choice list on the search panel header) can be changed. This allows the user to update the criteria to match that of the selected saved search. The action may also execute the search depending on how the saved search is configured.
• Personalize a saved search: The "Personalize..." option is displayed in the Saved Search choice list. Selecting this option opens the "Personalize Saved Searches" dialog, which allows user to personalize the saved search in the following ways.
  • Update a Saved Search: Change the name and UIHints for the selected saved search. Users are prevented from updating a saved search that is marked as immutable. The Apply and Ok buttons can be used to commit the changes.
  • Delete a Saved Search: delete the selected saved search (by using the Delete button). Users are prevented from changing a system saved search.
  • Duplicate a Saved Search: Clone the selected saved search (by using the Duplicate button).

Events

QueryOperationEvent is fired for operations performed on saved searches. The operations include changeMode, create, duplicate, delete, reset, select and update. The specific operation that triggers this event is stored as part of the QueryOperationEvent object. The query component by default registers an internal QueryOperationListener and invokes specific methods on the QueryModel. Please refer to the QueryModel for more details.

QueryEvent is fired in response to the user action to perform a query. For e.g., when the user hits the Search button or if the currently selected saved search is configured to "Run Automatically" when selected in the Saved Search choice list.

Geometry Management

• This component will be stretched if:
  • type="default" and its parent layout component is stretching the query (e.g. panelDashboard)
  • type="stretch"
• This component will not be stretched if:
  • type="default" and its parent layout component is not stretching the query (e.g. panelGroupLayout)
  • type="flow"
• The query component will only stretch its children if it is being stretched by its parent (or if type="stretch").

Events:

Type	Phases	Description
oracle.adf.view.rich.event.QueryEvent	Invoke Application Apply Request Values	The Query event is delivered when a query action is triggered.
oracle.adf.view.rich.event.QueryOperationEvent	Invoke Application Apply Request Values	The QueryOperationEvent is generated for all operations performed on saved searches. These include creating, deleting, duplicating, reseting and selecting a saved search.
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.

Nested Class Summary

Nested classes/interfaces inherited from class oracle.adf.view.rich.component.UIXQuery

UIXQuery.InternalQueryBean

Field Summary

static org.apache.myfaces.trinidad.bean.PropertyKey	ADD_FIELDS_BUTTON_ACCESS_KEY_KEY
static org.apache.myfaces.trinidad.bean.PropertyKey	ADD_FIELDS_BUTTON_TEXT_KEY
static org.apache.myfaces.trinidad.bean.PropertyKey	CLIENT_ATTRIBUTES_KEY
static org.apache.myfaces.trinidad.bean.PropertyKey	CLIENT_COMPONENT_KEY
static org.apache.myfaces.trinidad.bean.PropertyKey	CLIENT_LISTENERS_KEY
static String	COMPONENT_FAMILY
static String	COMPONENT_TYPE
static org.apache.myfaces.trinidad.bean.PropertyKey	CRITERION_FEATURES_KEY
static org.apache.myfaces.trinidad.bean.PropertyKey	CUSTOMIZATION_ID_KEY Deprecated.
static org.apache.myfaces.trinidad.bean.PropertyKey	DISCLOSED_KEY
static String	DISPLAY_MODE_COMPACT
static String	DISPLAY_MODE_DEFAULT
static String	DISPLAY_MODE_DESIGN
static org.apache.myfaces.trinidad.bean.PropertyKey	DISPLAY_MODE_KEY
static String	DISPLAY_MODE_SIMPLE
static org.apache.myfaces.trinidad.bean.PropertyKey	FIELD_WIDTH_KEY
static String	FOOTER_FACET
static org.apache.myfaces.trinidad.bean.PropertyKey	HEADER_TEXT_KEY
static String	HELP_FACET
static org.apache.myfaces.trinidad.bean.PropertyKey	HELP_TOPIC_ID_KEY
static String	INFO_FACET
static org.apache.myfaces.trinidad.bean.PropertyKey	INLINE_STYLE_KEY
static org.apache.myfaces.trinidad.bean.PropertyKey	LABEL_ALIGNMENT_KEY
static String	LABEL_ALIGNMENT_START
static String	LABEL_ALIGNMENT_TOP
static org.apache.myfaces.trinidad.bean.PropertyKey	LABEL_WIDTH_KEY
static org.apache.myfaces.trinidad.bean.PropertyKey	MAX_COLUMNS_KEY
static String	MODE_BUTTON_POSITION_FOOTER
static org.apache.myfaces.trinidad.bean.PropertyKey	MODE_BUTTON_POSITION_KEY
static String	MODE_BUTTON_POSITION_TOOLBAR
static org.apache.myfaces.trinidad.bean.PropertyKey	MODE_CHANGE_VISIBLE_KEY
static org.apache.myfaces.trinidad.bean.PropertyKey	PARTIAL_TRIGGERS_KEY
static org.apache.myfaces.trinidad.bean.PropertyKey	RESET_BUTTON_ACCESS_KEY_KEY
static org.apache.myfaces.trinidad.bean.PropertyKey	RESET_BUTTON_TEXT_KEY
static org.apache.myfaces.trinidad.bean.PropertyKey	RESULT_COMPONENT_ID_KEY
static org.apache.myfaces.trinidad.bean.PropertyKey	ROWS_KEY
static String	RUN_QUERY_AUTOMATICALLY_ALL_SAVED_SEARCHES
static org.apache.myfaces.trinidad.bean.PropertyKey	RUN_QUERY_AUTOMATICALLY_KEY
static String	RUN_QUERY_AUTOMATICALLY_SEARCH_DEPENDENT
static org.apache.myfaces.trinidad.bean.PropertyKey	SAVE_BUTTON_ACCESS_KEY_KEY
static org.apache.myfaces.trinidad.bean.PropertyKey	SAVE_BUTTON_TEXT_KEY
static String	SAVE_QUERY_MODE_DEFAULT
static String	SAVE_QUERY_MODE_HIDDEN
static org.apache.myfaces.trinidad.bean.PropertyKey	SAVE_QUERY_MODE_KEY
static String	SAVE_QUERY_MODE_READ_ONLY
static String	SAVE_RESULTS_LAYOUT_ALWAYS
static org.apache.myfaces.trinidad.bean.PropertyKey	SAVE_RESULTS_LAYOUT_KEY
static String	SAVE_RESULTS_LAYOUT_NEVER
static org.apache.myfaces.trinidad.bean.PropertyKey	SEARCH_BUTTON_ACCESS_KEY_KEY
static org.apache.myfaces.trinidad.bean.PropertyKey	SEARCH_BUTTON_TEXT_KEY
static org.apache.myfaces.trinidad.bean.PropertyKey	SHORT_DESC_KEY
static org.apache.myfaces.trinidad.bean.PropertyKey	SIMPLE_KEY Deprecated.
static org.apache.myfaces.trinidad.bean.PropertyKey	STYLE_CLASS_KEY
static String	TOOLBAR_FACET
static org.apache.myfaces.trinidad.bean.FacesBean.Type	TYPE
static String	TYPE_DEFAULT
static String	TYPE_FLOW
static org.apache.myfaces.trinidad.bean.PropertyKey	TYPE_KEY
static String	TYPE_STRETCH
static org.apache.myfaces.trinidad.bean.PropertyKey	UNSECURE_KEY
static org.apache.myfaces.trinidad.bean.PropertyKey	VISIBLE_KEY

Fields inherited from class oracle.adf.view.rich.component.UIXQuery

QUERY_REFRESH_LIST_KEY

Fields inherited from class oracle.adf.view.rich.component.PartialUIXQuery

CONJUNCTION_READ_ONLY_KEY, MODEL_KEY, QUERY_LISTENER_KEY, QUERY_OPERATION_LISTENER_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

Fields inherited from interface javax.faces.component.NamingContainer

SEPARATOR_CHAR

Constructor Summary

	RichQuery() Construct an instance of the RichQuery.
protected	RichQuery(String rendererType) Construct an instance of the RichQuery.

Method Summary

void	addClientBehavior(String eventName, javax.faces.component.behavior.ClientBehavior behavior)
char	getAddFieldsButtonAccessKey() Gets what accessKey will the component set for the add fields button.
String	getAddFieldsButtonText() Gets what Text will the component set for the add fields button.
protected org.apache.myfaces.trinidad.bean.FacesBean.Type	getBeanType()
Set	getClientAttributes() Gets a set of client attribute names.
Map<String,List<javax.faces.component.behavior.ClientBehavior>>	getClientBehaviors()
ClientListenerSet	getClientListeners() Gets a set of client listeners.
Set	getCriterionFeatures() Gets Additional criterion attributes that can be configured/set by the user.
String	getCustomizationId() Deprecated. This attribute is deprecated. This attribute will be removed in the next release. Use the 'id' attribute instead.
String	getDefaultEventName()
String	getDisplayMode() Gets the mode of display for the query component.
Collection<String>	getEventNames()
String	getFamily()
String	getFieldWidth() Gets the preferred width of the value part of the search field.
javax.faces.component.UIComponent	getFooter() Used to specify content that displays in the query footer.
String	getHeaderText() Gets the label of the query header.
javax.faces.component.UIComponent	getHelp() This facet is deprecated, instead the attribute 'helpTopicId' should be used for providing help.
String	getHelpTopicId() Gets the id used to look up a topic in a helpProvider.
javax.faces.component.UIComponent	getInfo() Used to specify content that provides additional information to the user.
String	getInlineStyle() Gets the CSS styles to use for this component.
String	getLabelAlignment() Gets the alignment of label prompts for a search field (criterion).
String	getLabelWidth() Gets the preferred width of the label.
int	getMaxColumns() Gets the maximum number of columns to show.
String	getModeButtonPosition() Gets the location the mode button is displayed.
String[]	getPartialTriggers() Gets the IDs of the components that should trigger a partial update.
char	getResetButtonAccessKey() Gets what accessKey will the component set for the reset button.
String	getResetButtonText() Gets what Text will the component set for the reset button.
String	getResultComponentId() Gets a search expression identifying the results component (usually a table or treeTable) that will display the results of the query.
int	getRows() Gets the number of rows after which to start a new column.
String	getRunQueryAutomatically() Gets Indicates if the query should be run automatically for saved searches.
char	getSaveButtonAccessKey() Gets what accessKey will the component set for the save button.
String	getSaveButtonText() Gets what Text will the component set for the save button.
String	getSaveQueryMode() Gets the mode of display and usage for saved searches.
String	getSaveResultsLayout() Gets Indicates if the layout of the results component is automatically persisted.
char	getSearchButtonAccessKey() Gets what accessKey will the component set for the search button.
String	getSearchButtonText() Gets what Text will the component set for the search button.
String	getShortDesc() Gets the short description of the component.
String	getStyleClass() Gets a CSS style class to use for this component.
javax.faces.component.UIComponent	getToolbar() Used to specify content that displays in the query header.
String	getType() Gets how the component will handle geometry management.
Set<String>	getUnsecure() Gets A whitespace separated list of attributes whose values ordinarily can be set only on the server, but need to be settable on the client.
boolean	isClientComponent() Gets whether a client-side component will be generated.
boolean	isDisclosed() Gets a boolean value that determines if query component needs to be disclosed or not.
boolean	isModeChangeVisible() Gets the rendering of mode change button.
boolean	isSimple() Deprecated. This attribute is deprecated, displayMode=simple should be used instead.
boolean	isVisible() Gets the visibility of the component.
void	setAddFieldsButtonAccessKey(char addFieldsButtonAccessKey) Sets what accessKey will the component set for the add fields button.
void	setAddFieldsButtonText(String addFieldsButtonText) Sets what Text will the component set for the add fields button.
void	setClientAttributes(Set clientAttributes) Sets a set of client attribute names.
void	setClientComponent(boolean clientComponent) Sets whether a client-side component will be generated.
void	setClientListeners(ClientListenerSet clientListeners) Sets a set of client listeners.
void	setCriterionFeatures(Set criterionFeatures) Sets Additional criterion attributes that can be configured/set by the user.
void	setCustomizationId(String customizationId) Deprecated. This attribute is deprecated. This attribute will be removed in the next release. Use the 'id' attribute instead.
void	setDisclosed(boolean disclosed) Sets a boolean value that determines if query component needs to be disclosed or not.
void	setDisplayMode(String displayMode) Sets the mode of display for the query component.
void	setFieldWidth(String fieldWidth) Sets the preferred width of the value part of the search field.
void	setFooter(javax.faces.component.UIComponent footerFacet) Used to specify content that displays in the query footer.
void	setHeaderText(String headerText) Sets the label of the query header.
void	setHelp(javax.faces.component.UIComponent helpFacet) This facet is deprecated, instead the attribute 'helpTopicId' should be used for providing help.
void	setHelpTopicId(String helpTopicId) Sets the id used to look up a topic in a helpProvider.
void	setInfo(javax.faces.component.UIComponent infoFacet) Used to specify content that provides additional information to the user.
void	setInlineStyle(String inlineStyle) Sets the CSS styles to use for this component.
void	setLabelAlignment(String labelAlignment) Sets the alignment of label prompts for a search field (criterion).
void	setLabelWidth(String labelWidth) Sets the preferred width of the label.
void	setMaxColumns(int maxColumns) Sets the maximum number of columns to show.
void	setModeButtonPosition(String modeButtonPosition) Sets the location the mode button is displayed.
void	setModeChangeVisible(boolean modeChangeVisible) Sets the rendering of mode change button.
void	setPartialTriggers(String[] partialTriggers) Sets the IDs of the components that should trigger a partial update.
void	setResetButtonAccessKey(char resetButtonAccessKey) Sets what accessKey will the component set for the reset button.
void	setResetButtonText(String resetButtonText) Sets what Text will the component set for the reset button.
void	setResultComponentId(String resultComponentId) Sets a search expression identifying the results component (usually a table or treeTable) that will display the results of the query.
void	setRows(int rows) Sets the number of rows after which to start a new column.
void	setRunQueryAutomatically(String runQueryAutomatically) Sets Indicates if the query should be run automatically for saved searches.
void	setSaveButtonAccessKey(char saveButtonAccessKey) Sets what accessKey will the component set for the save button.
void	setSaveButtonText(String saveButtonText) Sets what Text will the component set for the save button.
void	setSaveQueryMode(String saveQueryMode) Sets the mode of display and usage for saved searches.
void	setSaveResultsLayout(String saveResultsLayout) Sets Indicates if the layout of the results component is automatically persisted.
void	setSearchButtonAccessKey(char searchButtonAccessKey) Sets what accessKey will the component set for the search button.
void	setSearchButtonText(String searchButtonText) Sets what Text will the component set for the search button.
void	setShortDesc(String shortDesc) Sets the short description of the component.
void	setSimple(boolean simple) Deprecated. This attribute is deprecated, displayMode=simple should be used instead.
void	setStyleClass(String styleClass) Sets a CSS style class to use for this component.
void	setToolbar(javax.faces.component.UIComponent toolbarFacet) Used to specify content that displays in the query header.
void	setType(String type) Sets how the component will handle geometry management.
void	setUnsecure(Set<String> unsecure) Sets A whitespace separated list of attributes whose values ordinarily can be set only on the server, but need to be settable on the client.
void	setVisible(boolean visible) Sets the visibility of the component.

Methods inherited from class oracle.adf.view.rich.component.UIXQuery

broadcast, decodeChildrenImpl, encodeBegin, invokeOnComponent, queueEvent, refresh, setQueryListener, setQueryOperationListener

Methods inherited from class oracle.adf.view.rich.component.PartialUIXQuery

addQueryListener, addQueryOperationListener, getModel, getQueryListener, getQueryListeners, getQueryOperationListener, getQueryOperationListeners, getValue, isConjunctionReadOnly, removeQueryListener, removeQueryOperationListener, setConjunctionReadOnly, setModel, setQueryListener, setQueryOperationListener, setValue

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

adaptMethodBinding, addAttributeChange, addAttributeChangeListener, addComponentChange, addComponentChange, addComponentChangeFilter, addFacesListener, broadcastToMethodBinding, broadcastToMethodExpression, clearInitialState, createFacesBean, decode, decodeChildren, encodeChildren, encodeEnd, findComponent, getAttributeChangeListener, getAttributeChangeListeners, getAttributes, getBooleanProperty, getChildCount, getChildren, getClientId, getComponentChangeFilters, getContainerClientId, getFacesBean, getFacesContext, getFacesListeners, getFacet, getFacetCount, getFacetNames, getFacets, getFacetsAndChildren, getId, getIntProperty, getLifecycleRenderer, getListenersForEventClass, getParent, getProperty, getPropertyKey, getRenderedFacetsAndChildren, getRenderer, getRendererType, getRendersChildren, getValueBinding, getValueExpression, initialStateMarked, invokeOnChildrenComponents, invokeOnNamingContainerComponent, isRendered, isTransient, markInitialState, processDecodes, processRestoreState, processSaveState, processUpdates, processValidators, 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

Field Detail

LABEL_ALIGNMENT_START

public static final String LABEL_ALIGNMENT_START

See Also:

Constant Field Values

LABEL_ALIGNMENT_TOP

public static final String LABEL_ALIGNMENT_TOP

See Also:

Constant Field Values

MODE_BUTTON_POSITION_FOOTER

public static final String MODE_BUTTON_POSITION_FOOTER

See Also:

Constant Field Values

MODE_BUTTON_POSITION_TOOLBAR

public static final String MODE_BUTTON_POSITION_TOOLBAR

See Also:

Constant Field Values

SAVE_RESULTS_LAYOUT_ALWAYS

public static final String SAVE_RESULTS_LAYOUT_ALWAYS

See Also:

Constant Field Values

SAVE_RESULTS_LAYOUT_NEVER

public static final String SAVE_RESULTS_LAYOUT_NEVER

See Also:

Constant Field Values

SAVE_QUERY_MODE_DEFAULT

public static final String SAVE_QUERY_MODE_DEFAULT

See Also:

Constant Field Values

SAVE_QUERY_MODE_READ_ONLY

public static final String SAVE_QUERY_MODE_READ_ONLY

See Also:

Constant Field Values

SAVE_QUERY_MODE_HIDDEN

public static final String SAVE_QUERY_MODE_HIDDEN

See Also:

Constant Field Values

DISPLAY_MODE_DEFAULT

public static final String DISPLAY_MODE_DEFAULT

See Also:

Constant Field Values

DISPLAY_MODE_COMPACT

public static final String DISPLAY_MODE_COMPACT

See Also:

Constant Field Values

DISPLAY_MODE_SIMPLE

public static final String DISPLAY_MODE_SIMPLE

See Also:

Constant Field Values

DISPLAY_MODE_DESIGN

public static final String DISPLAY_MODE_DESIGN

See Also:

Constant Field Values

TYPE_DEFAULT

public static final String TYPE_DEFAULT

See Also:

Constant Field Values

TYPE_FLOW

public static final String TYPE_FLOW

See Also:

Constant Field Values

TYPE_STRETCH

public static final String TYPE_STRETCH

See Also:

Constant Field Values

RUN_QUERY_AUTOMATICALLY_ALL_SAVED_SEARCHES

public static final String RUN_QUERY_AUTOMATICALLY_ALL_SAVED_SEARCHES

See Also:

Constant Field Values

RUN_QUERY_AUTOMATICALLY_SEARCH_DEPENDENT

public static final String RUN_QUERY_AUTOMATICALLY_SEARCH_DEPENDENT

See Also:

Constant Field Values

TYPE

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

DISCLOSED_KEY

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

FIELD_WIDTH_KEY

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

HEADER_TEXT_KEY

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

HELP_TOPIC_ID_KEY

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

LABEL_ALIGNMENT_KEY

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

LABEL_WIDTH_KEY

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

MAX_COLUMNS_KEY

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

MODE_BUTTON_POSITION_KEY

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

MODE_CHANGE_VISIBLE_KEY

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

RESULT_COMPONENT_ID_KEY

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

ROWS_KEY

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

SAVE_RESULTS_LAYOUT_KEY

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

SAVE_QUERY_MODE_KEY

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

DISPLAY_MODE_KEY

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

SIMPLE_KEY

@Deprecated
public static final org.apache.myfaces.trinidad.bean.PropertyKey SIMPLE_KEY

Deprecated.

TYPE_KEY

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

SEARCH_BUTTON_TEXT_KEY

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

SEARCH_BUTTON_ACCESS_KEY_KEY

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

RESET_BUTTON_TEXT_KEY

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

RESET_BUTTON_ACCESS_KEY_KEY

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

SAVE_BUTTON_TEXT_KEY

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

SAVE_BUTTON_ACCESS_KEY_KEY

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

ADD_FIELDS_BUTTON_TEXT_KEY

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

ADD_FIELDS_BUTTON_ACCESS_KEY_KEY

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

CRITERION_FEATURES_KEY

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

RUN_QUERY_AUTOMATICALLY_KEY

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

INLINE_STYLE_KEY

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

STYLE_CLASS_KEY

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

SHORT_DESC_KEY

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

UNSECURE_KEY

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

VISIBLE_KEY

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

CUSTOMIZATION_ID_KEY

@Deprecated
public static final org.apache.myfaces.trinidad.bean.PropertyKey CUSTOMIZATION_ID_KEY

Deprecated.

CLIENT_COMPONENT_KEY

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

CLIENT_ATTRIBUTES_KEY

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

PARTIAL_TRIGGERS_KEY

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

CLIENT_LISTENERS_KEY

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

HELP_FACET

public static final String HELP_FACET

See Also:

Constant Field Values

TOOLBAR_FACET

public static final String TOOLBAR_FACET

See Also:

Constant Field Values

INFO_FACET

public static final String INFO_FACET

See Also:

Constant Field Values

FOOTER_FACET

public static final String FOOTER_FACET

See Also:

Constant Field Values

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

RichQuery

public RichQuery()

Construct an instance of the RichQuery.

RichQuery

protected RichQuery(String rendererType)

Construct an instance of the RichQuery.

Method Detail

getHelp

public final javax.faces.component.UIComponent getHelp()

This facet is deprecated, instead the attribute 'helpTopicId' should be used for providing help. Both the help facet (when rendered inline) and helpTopicId with instructions text are rendered in the same spot, so if helpTopicId is specified and it has instructions text, the help facet will not be rendered if specified inline.
Help content that is displayed to the user. The content of the help is displayed inline inside the header content or as a popup through a link. In JSP pages only one component is allowed. When using Facelets multiple components are allowed.

setHelp

public final void setHelp(javax.faces.component.UIComponent helpFacet)

This facet is deprecated, instead the attribute 'helpTopicId' should be used for providing help. Both the help facet (when rendered inline) and helpTopicId with instructions text are rendered in the same spot, so if helpTopicId is specified and it has instructions text, the help facet will not be rendered if specified inline.
Help content that is displayed to the user. The content of the help is displayed inline inside the header content or as a popup through a link. In JSP pages only one component is allowed. When using Facelets multiple components are allowed.

getToolbar

public final javax.faces.component.UIComponent getToolbar()

Used to specify content that displays in the query header. Contents of this facet will be shown in both Basic and Advanced mode. For example, to show custom command buttons in both Basic and Advanced mode, buttons should be added to the toolbar facet. Must be only one component, multiple components are not supported by this facet

setToolbar

public final void setToolbar(javax.faces.component.UIComponent toolbarFacet)

Used to specify content that displays in the query header. Contents of this facet will be shown in both Basic and Advanced mode. For example, to show custom command buttons in both Basic and Advanced mode, buttons should be added to the toolbar facet. Must be only one component, multiple components are not supported by this facet

getInfo

public final javax.faces.component.UIComponent getInfo()

Used to specify content that provides additional information to the user. This content is usually displayed under the search panel header and end aligned with the header. In JSP pages only one component is allowed. When using Facelets multiple components are allowed.

setInfo

public final void setInfo(javax.faces.component.UIComponent infoFacet)

Used to specify content that provides additional information to the user. This content is usually displayed under the search panel header and end aligned with the header. In JSP pages only one component is allowed. When using Facelets multiple components are allowed.

getFooter

public final javax.faces.component.UIComponent getFooter()

Used to specify content that displays in the query footer. If a footer is not specified then an 'Add Fields' dropdown is automatically added to the facet. If a footer facet is specified, (that includes custom buttons for example) the default 'Add Fields' dropdown will not appear and users are required to specify it explicitly in the footer facet along with the other content if this functionality is desired. In addition, contents of this facet will only be shown in the Advanced mode. In JSP pages only one component is allowed. When using Facelets multiple components are allowed.

setFooter

public final void setFooter(javax.faces.component.UIComponent footerFacet)

Used to specify content that displays in the query footer. If a footer is not specified then an 'Add Fields' dropdown is automatically added to the facet. If a footer facet is specified, (that includes custom buttons for example) the default 'Add Fields' dropdown will not appear and users are required to specify it explicitly in the footer facet along with the other content if this functionality is desired. In addition, contents of this facet will only be shown in the Advanced mode. In JSP pages only one component is allowed. When using Facelets multiple components are allowed.

isDisclosed

public final boolean isDisclosed()

Gets a boolean value that determines if query component needs to be disclosed or not.

Returns:

the new disclosed value

setDisclosed

public final void setDisclosed(boolean disclosed)

Sets a boolean value that determines if query component needs to be disclosed or not.

Parameters:

disclosed - the new disclosed value

getFieldWidth

public final String getFieldWidth()

Gets the preferred width of the value part of the search field. Usually a percentage, but may be specified as either a percentage or an absolute number of pixels. If the width is not specified, it will default appropriately. If specified as a percentage the sum of labelWidth and fieldWidth should add up to 100%, regardless of the number of columns. If the fieldWidth is specified and is a percentage the labelWidth will be derived appropriately if not specified.

Returns:

the new fieldWidth value

setFieldWidth

public final void setFieldWidth(String fieldWidth)

Sets the preferred width of the value part of the search field. Usually a percentage, but may be specified as either a percentage or an absolute number of pixels. If the width is not specified, it will default appropriately. If specified as a percentage the sum of labelWidth and fieldWidth should add up to 100%, regardless of the number of columns. If the fieldWidth is specified and is a percentage the labelWidth will be derived appropriately if not specified.

Parameters:

fieldWidth - the new fieldWidth value

getHeaderText

public final String getHeaderText()

Gets the label of the query header.

This is a required property on the component.

Returns:

the new headerText value

setHeaderText

public final void setHeaderText(String headerText)

Sets the label of the query header.

This is a required property on the component.

Parameters:

headerText - the new headerText value

getHelpTopicId

public final String getHelpTopicId()

Gets the id used to look up a topic in a helpProvider.

Returns:

the new helpTopicId value

setHelpTopicId

public final void setHelpTopicId(String helpTopicId)

Sets the id used to look up a topic in a helpProvider.

Parameters:

helpTopicId - the new helpTopicId value

getLabelAlignment

public final String getLabelAlignment()

Gets the alignment of label prompts for a search field (criterion). 'start' places the label before the operator and value fields. 'top' renders the label above the operator and value fields.

Returns:

the new labelAlignment value

setLabelAlignment

public final void setLabelAlignment(String labelAlignment)

Sets the alignment of label prompts for a search field (criterion). 'start' places the label before the operator and value fields. 'top' renders the label above the operator and value fields.

Parameters:

labelAlignment - the new labelAlignment value

getLabelWidth

public final String getLabelWidth()

Gets the preferred width of the label. Usually a percentage, but may be specified as either a percentage or an absolute number of pixels. If the width is not specified, it will default appropriately. If specified as a percentage the sum of labelWidth and fieldWidth should add up to 100%, regardless of the number of columns. If the labelWidth is specified and is a percentage the fieldWidth will be derived appropriately if not specified.

Returns:

the new labelWidth value

setLabelWidth

public final void setLabelWidth(String labelWidth)

Sets the preferred width of the label. Usually a percentage, but may be specified as either a percentage or an absolute number of pixels. If the width is not specified, it will default appropriately. If specified as a percentage the sum of labelWidth and fieldWidth should add up to 100%, regardless of the number of columns. If the labelWidth is specified and is a percentage the fieldWidth will be derived appropriately if not specified.

Parameters:

labelWidth - the new labelWidth value

getMaxColumns

public final int getMaxColumns()

Gets the maximum number of columns to show. This property defaults to 3. If the panelForm (containing the search fields) is inside of another panelForm, this will always be 1.

Returns:

the new maxColumns value

setMaxColumns

public final void setMaxColumns(int maxColumns)

Sets the maximum number of columns to show. This property defaults to 3. If the panelForm (containing the search fields) is inside of another panelForm, this will always be 1.

Parameters:

maxColumns - the new maxColumns value

getModeButtonPosition

public final String getModeButtonPosition()

Gets the location the mode button is displayed. Valid values are footer and toolbar (default).

Returns:

the new modeButtonPosition value

setModeButtonPosition

public final void setModeButtonPosition(String modeButtonPosition)

Sets the location the mode button is displayed. Valid values are footer and toolbar (default).

Parameters:

modeButtonPosition - the new modeButtonPosition value

isModeChangeVisible

public final boolean isModeChangeVisible()

Gets the rendering of mode change button. This button is used to switch the modes between basic and advanced. In addition if users choose to toggle between the query and quickQuery components, they can do so by adding a button to the toolbar facet. The actionListener on the button can then be wired to a method on a session scoped managed bean.

Returns:

the new modeChangeVisible value

setModeChangeVisible

public final void setModeChangeVisible(boolean modeChangeVisible)

Sets the rendering of mode change button. This button is used to switch the modes between basic and advanced. In addition if users choose to toggle between the query and quickQuery components, they can do so by adding a button to the toolbar facet. The actionListener on the button can then be wired to a method on a session scoped managed bean.

Parameters:

modeChangeVisible - the new modeChangeVisible value

getResultComponentId

public final String getResultComponentId()

Gets a search expression identifying the results component (usually a table or treeTable) that will display the results of the query. Expressions are relative to this source component and must account for NamingContainers. If the results component is already inside of a naming container, you can prepend a single colon to start the search from the root, or multiple colons to move up through the NamingContainers. For example, a leading "::" will pop out of the component's naming container (or itself if the component is a naming container) and begin the search from there, ":::" will pop out of two naming containers (including itself if the component is a naming container) and begin the search from there, etc. Product teams should ensure that this value is set correctly so that the search operation triggers a partial page refresh of the component. Also, the 'Save Results Layout' feature, (applied on the current saved search) uses this value as a UIHint in the model.

Returns:

the new resultComponentId value

setResultComponentId

public final void setResultComponentId(String resultComponentId)

Sets a search expression identifying the results component (usually a table or treeTable) that will display the results of the query. Expressions are relative to this source component and must account for NamingContainers. If the results component is already inside of a naming container, you can prepend a single colon to start the search from the root, or multiple colons to move up through the NamingContainers. For example, a leading "::" will pop out of the component's naming container (or itself if the component is a naming container) and begin the search from there, ":::" will pop out of two naming containers (including itself if the component is a naming container) and begin the search from there, etc. Product teams should ensure that this value is set correctly so that the search operation triggers a partial page refresh of the component. Also, the 'Save Results Layout' feature, (applied on the current saved search) uses this value as a UIHint in the model.

Parameters:

resultComponentId - the new resultComponentId value

getRows

public final int getRows()

Gets the number of rows after which to start a new column. The number of rows actually rendered depends also on the "maxColumns" attribute. When the number of children rendered equals the rows value, the next child is rendered in the next column. If the children will not fit in the given number of rows and columns, the number of rows will increase to accommodate the children. When left blank, rows defaults to the maximum integer value.

Returns:

the new rows value

setRows

public final void setRows(int rows)

Sets the number of rows after which to start a new column. The number of rows actually rendered depends also on the "maxColumns" attribute. When the number of children rendered equals the rows value, the next child is rendered in the next column. If the children will not fit in the given number of rows and columns, the number of rows will increase to accommodate the children. When left blank, rows defaults to the maximum integer value.

Parameters:

rows - the new rows value

getSaveResultsLayout

public final String getSaveResultsLayout()

Gets Indicates if the layout of the results component is automatically persisted. Default value is 'always'.

Returns:

the new saveResultsLayout value

setSaveResultsLayout

public final void setSaveResultsLayout(String saveResultsLayout)

Sets Indicates if the layout of the results component is automatically persisted. Default value is 'always'.

Parameters:

saveResultsLayout - the new saveResultsLayout value

getSaveQueryMode

public final String getSaveQueryMode()

Gets the mode of display and usage for saved searches.

• default: all saved searches are displayed. In addition any saved search can be created/duplicated but only user saved searches can be deleted/updated.
• readOnly: saved searches to be viewed/selected, but not edited
• hidden: all saved searches are hidden

Returns:

the new saveQueryMode value

setSaveQueryMode

public final void setSaveQueryMode(String saveQueryMode)

Sets the mode of display and usage for saved searches.

• default: all saved searches are displayed. In addition any saved search can be created/duplicated but only user saved searches can be deleted/updated.
• readOnly: saved searches to be viewed/selected, but not edited
• hidden: all saved searches are hidden

Parameters:

saveQueryMode - the new saveQueryMode value

getDisplayMode

public final String getDisplayMode()

Gets the mode of display for the query component.

• default: displays all parts of the query component.
• compact: Similar to 'default' except, in this mode :
• • The header text will not be rendered and headerText property will always be ignored.
  • The component will be rendered undisclosed unless the disclosed property is explicitly set to true.
  • The mode button will be rendered in the footer unless the 'modeButtonPosition' property is set to 'toolbar'. If the modeChangeVisible' property is set to false, it is not rendered at all.
  • The layout of the saved search dropdown will be left aligned on the header.
  • No container or borders will be present around the header or toolbar.
• simple: In this mode the header and footer will not be rendered and the following properties will be ignored - disclosed, headerText, modeButtonPosition, modeChangeVisible.
• design: Similar to 'simple' and used mostly for designing the Query Descriptor.

Returns:

the new displayMode value

setDisplayMode

public final void setDisplayMode(String displayMode)

Sets the mode of display for the query component.

• default: displays all parts of the query component.
• compact: Similar to 'default' except, in this mode :
• • The header text will not be rendered and headerText property will always be ignored.
  • The component will be rendered undisclosed unless the disclosed property is explicitly set to true.
  • The mode button will be rendered in the footer unless the 'modeButtonPosition' property is set to 'toolbar'. If the modeChangeVisible' property is set to false, it is not rendered at all.
  • The layout of the saved search dropdown will be left aligned on the header.
  • No container or borders will be present around the header or toolbar.
• simple: In this mode the header and footer will not be rendered and the following properties will be ignored - disclosed, headerText, modeButtonPosition, modeChangeVisible.
• design: Similar to 'simple' and used mostly for designing the Query Descriptor.

Parameters:

displayMode - the new displayMode value

isSimple

@Deprecated
public final boolean isSimple()

Deprecated. This attribute is deprecated, displayMode=simple should be used instead.

Gets the boolean that determines if the header and footer will be rendered. This attribute is deprecated and displayMode=simple should be used instead.

Returns:

the new simple value

setSimple

@Deprecated
public final void setSimple(boolean simple)

Deprecated. This attribute is deprecated, displayMode=simple should be used instead.

Sets the boolean that determines if the header and footer will be rendered. This attribute is deprecated and displayMode=simple should be used instead.

Parameters:

simple - the new simple value

getType

public final String getType()

Gets how the component will handle geometry management. Options are:

• default - either flow or stretch, depending on the container the query is inside
• flow - does not support being stretched and will not attempt to stretch the children; the height of the component will be determined by the browser based on the children
• stretch - supports being stretched and will attempt to stretch the sole child or will wrap the children without stretching them; the height of this component is in no way determined by the children

Returns:

the new type value

setType

public final void setType(String type)

Sets how the component will handle geometry management. Options are:

• default - either flow or stretch, depending on the container the query is inside
• flow - does not support being stretched and will not attempt to stretch the children; the height of the component will be determined by the browser based on the children
• stretch - supports being stretched and will attempt to stretch the sole child or will wrap the children without stretching them; the height of this component is in no way determined by the children

Parameters:

type - the new type value

getSearchButtonText

public final String getSearchButtonText()

Gets what Text will the component set for the search button. Options are:

• null - default button text will be used.
• provide text of your choice

Returns:

the new searchButtonText value

setSearchButtonText

public final void setSearchButtonText(String searchButtonText)

Sets what Text will the component set for the search button. Options are:

• null - default button text will be used.
• provide text of your choice

Parameters:

searchButtonText - the new searchButtonText value

getSearchButtonAccessKey

public final char getSearchButtonAccessKey()

Gets what accessKey will the component set for the search button. Options are:

• null - no access key will be set.
• provide access key of your choice

Returns:

the new searchButtonAccessKey value

setSearchButtonAccessKey

public final void setSearchButtonAccessKey(char searchButtonAccessKey)

Sets what accessKey will the component set for the search button. Options are:

• null - no access key will be set.
• provide access key of your choice

Parameters:

searchButtonAccessKey - the new searchButtonAccessKey value

getResetButtonText

public final String getResetButtonText()

Gets what Text will the component set for the reset button. Options are:

• null - default reset button text will be used.
• provide text and access key of your choice

Returns:

the new resetButtonText value

setResetButtonText

public final void setResetButtonText(String resetButtonText)

Sets what Text will the component set for the reset button. Options are:

• null - default reset button text will be used.
• provide text and access key of your choice

Parameters:

resetButtonText - the new resetButtonText value

getResetButtonAccessKey

public final char getResetButtonAccessKey()

Gets what accessKey will the component set for the reset button. Options are:

• null - No access key will be set for the reset button.
• provide access key of your choice

Returns:

the new resetButtonAccessKey value

setResetButtonAccessKey

public final void setResetButtonAccessKey(char resetButtonAccessKey)

Sets what accessKey will the component set for the reset button. Options are:

• null - No access key will be set for the reset button.
• provide access key of your choice

Parameters:

resetButtonAccessKey - the new resetButtonAccessKey value

getSaveButtonText

public final String getSaveButtonText()

Gets what Text will the component set for the save button. Options are:

• null - default save button text will be used.
• provide text of your choice

Returns:

the new saveButtonText value

setSaveButtonText

public final void setSaveButtonText(String saveButtonText)

Sets what Text will the component set for the save button. Options are:

• null - default save button text will be used.
• provide text of your choice

Parameters:

saveButtonText - the new saveButtonText value

getSaveButtonAccessKey

public final char getSaveButtonAccessKey()

Gets what accessKey will the component set for the save button. Options are:

• null - No access key will be set for the save button.
• provide access key of your choice

Returns:

the new saveButtonAccessKey value

setSaveButtonAccessKey

public final void setSaveButtonAccessKey(char saveButtonAccessKey)

Sets what accessKey will the component set for the save button. Options are:

• null - No access key will be set for the save button.
• provide access key of your choice

Parameters:

saveButtonAccessKey - the new saveButtonAccessKey value

getAddFieldsButtonText

public final String getAddFieldsButtonText()

Gets what Text will the component set for the add fields button. Options are:

• null - default add fields button text will be used.
• provide text of your choice

Returns:

the new addFieldsButtonText value

setAddFieldsButtonText

public final void setAddFieldsButtonText(String addFieldsButtonText)

Sets what Text will the component set for the add fields button. Options are:

• null - default add fields button text will be used.
• provide text of your choice

Parameters:

addFieldsButtonText - the new addFieldsButtonText value

getAddFieldsButtonAccessKey

public final char getAddFieldsButtonAccessKey()

Gets what accessKey will the component set for the add fields button. Options are:

• null - No access key will be set for the add fields button.
• provide access key of your choice

Returns:

the new addFieldsButtonAccessKey value

setAddFieldsButtonAccessKey

public final void setAddFieldsButtonAccessKey(char addFieldsButtonAccessKey)

Sets what accessKey will the component set for the add fields button. Options are:

• null - No access key will be set for the add fields button.
• provide access key of your choice

Parameters:

addFieldsButtonAccessKey - the new addFieldsButtonAccessKey value

getCriterionFeatures

public final Set getCriterionFeatures()

Gets Additional criterion attributes that can be configured/set by the user. Currently we support the following two features

• matchCaseDisplayed - This allows user to set matchCase for a criterion. This option is available only for String data types.
• requiredDisplayed - This allows user to set whether a criterion is required/selectively required.

Returns:

the new criterionFeatures value

setCriterionFeatures

public final void setCriterionFeatures(Set criterionFeatures)

Sets Additional criterion attributes that can be configured/set by the user. Currently we support the following two features

• matchCaseDisplayed - This allows user to set matchCase for a criterion. This option is available only for String data types.
• requiredDisplayed - This allows user to set whether a criterion is required/selectively required.

Parameters:

criterionFeatures - the new criterionFeatures value

getRunQueryAutomatically

public final String getRunQueryAutomatically()

Gets Indicates if the query should be run automatically for saved searches. The possible values are

• allSavedSearches - query shall be run automatically for system and end user saved searches. This will be done when the query component is initially loaded or whenever the saved search is changed. Query shall also be run automatically on "reset" operation. For new saved searches created by the user, "Run Automatically" option shall not be displayed to the user and will be implicitly set.
• searchDependent (default) - "Run Automatically" option can be chosen by the developer at design time for each system query. End user can choose this option as well when a new saved search is created. By default this option shall be set in the UI, when a saved search is being created.

Returns:

the new runQueryAutomatically value

setRunQueryAutomatically

public final void setRunQueryAutomatically(String runQueryAutomatically)

Sets Indicates if the query should be run automatically for saved searches. The possible values are

• allSavedSearches - query shall be run automatically for system and end user saved searches. This will be done when the query component is initially loaded or whenever the saved search is changed. Query shall also be run automatically on "reset" operation. For new saved searches created by the user, "Run Automatically" option shall not be displayed to the user and will be implicitly set.
• searchDependent (default) - "Run Automatically" option can be chosen by the developer at design time for each system query. End user can choose this option as well when a new saved search is created. By default this option shall be set in the UI, when a saved search is being created.

Parameters:

runQueryAutomatically - the new runQueryAutomatically value

getInlineStyle

public final String getInlineStyle()

Gets the CSS styles to use for this component. This is intended for basic style changes. The inlineStyle is a set of CSS styles that are applied to the root DOM element of the component. Be aware that because of browser CSS precedence rules, CSS rendered on a DOM element takes precedence over external stylesheets like the skin file. Therefore skins will not be able to override what you set on this attribute. If the inlineStyle's CSS properties do not affect the DOM element you want affected, then you will have to create a skin and use the skinning keys which are meant to target particular DOM elements, like ::label or ::icon-style.

Returns:

the new inlineStyle value

setInlineStyle

public final void setInlineStyle(String inlineStyle)

Sets the CSS styles to use for this component. This is intended for basic style changes. The inlineStyle is a set of CSS styles that are applied to the root DOM element of the component. Be aware that because of browser CSS precedence rules, CSS rendered on a DOM element takes precedence over external stylesheets like the skin file. Therefore skins will not be able to override what you set on this attribute. If the inlineStyle's CSS properties do not affect the DOM element you want affected, then you will have to create a skin and use the skinning keys which are meant to target particular DOM elements, like ::label or ::icon-style.

Parameters:

inlineStyle - the new inlineStyle value

getStyleClass

public final String getStyleClass()

Gets a CSS style class to use for this component. The style class can be defined in your jspx page or in a skinning CSS file, for example, or you can use one of our public style classes, like 'AFInstructionText'.

Returns:

the new styleClass value

setStyleClass

public final void setStyleClass(String styleClass)

Sets a CSS style class to use for this component. The style class can be defined in your jspx page or in a skinning CSS file, for example, or you can use one of our public style classes, like 'AFInstructionText'.

Parameters:

styleClass - the new styleClass value

getShortDesc

public final String getShortDesc()

Gets the short description of the component. The shortDesc text may be used in two different ways, depending on the component.

For components with images, the shortDesc is often used to render an HTML alt attribute for the image. Please see the accessibility guidelines section for correct alt text usage of the shortDesc attribute.

shortDesc is also commonly used to render an HTML title attribute, which is used by user agents to display tooltip help text. In this case the behavior for the tooltip is controlled by the user agent, e.g. Firefox 2 truncates long tooltips. For form components, the shortDesc is displayed in a note window. For components that support the helpTopicId attribute and are not using the shortDesc as image alt text, it is recommended that helpTopicId is used instead of shortDesc as it is more flexible and provides more accessible descriptive text than the use of the title attribute.

Returns:

the new shortDesc value

setShortDesc

public final void setShortDesc(String shortDesc)

Sets the short description of the component. The shortDesc text may be used in two different ways, depending on the component.

For components with images, the shortDesc is often used to render an HTML alt attribute for the image. Please see the accessibility guidelines section for correct alt text usage of the shortDesc attribute.

shortDesc is also commonly used to render an HTML title attribute, which is used by user agents to display tooltip help text. In this case the behavior for the tooltip is controlled by the user agent, e.g. Firefox 2 truncates long tooltips. For form components, the shortDesc is displayed in a note window. For components that support the helpTopicId attribute and are not using the shortDesc as image alt text, it is recommended that helpTopicId is used instead of shortDesc as it is more flexible and provides more accessible descriptive text than the use of the title attribute.

Parameters:

shortDesc - the new shortDesc value

getUnsecure

public final Set<String> getUnsecure()

Gets A whitespace separated list of attributes whose values ordinarily can be set only on the server, but need to be settable on the client. Currently, this is supported only for the "disabled" attribute. Note that when you are able to set a property on the client, you will be allowed to by using the the .setProperty('attribute', newValue) method, but not the .setXXXAttribute(newValue) method. For example, if you have unsecure="disabled", then on the client you can use the method .setProperty('disabled', false), while the method .setDisabled(false) will not work and will provide a javascript error that setDisabled is not a function.

Returns:

the new unsecure value

setUnsecure

public final void setUnsecure(Set<String> unsecure)

Sets A whitespace separated list of attributes whose values ordinarily can be set only on the server, but need to be settable on the client. Currently, this is supported only for the "disabled" attribute. Note that when you are able to set a property on the client, you will be allowed to by using the the .setProperty('attribute', newValue) method, but not the .setXXXAttribute(newValue) method. For example, if you have unsecure="disabled", then on the client you can use the method .setProperty('disabled', false), while the method .setDisabled(false) will not work and will provide a javascript error that setDisabled is not a function.

Parameters:

unsecure - the new unsecure value

isVisible

public final boolean isVisible()

Gets the visibility of the component. If it is "false", the component will be hidden on the client. Unlike "rendered", this does not affect the lifecycle on the server - the component may have its bindings executed, etc. - and the visibility of the component can be toggled on and off on the client, or toggled with PPR. When "rendered" is false, the component will not in any way be rendered, and cannot be made visible on the client. In most cases, use the "rendered" property instead of the "visible" property.

Returns:

the new visible value

setVisible

public final void setVisible(boolean visible)

Sets the visibility of the component. If it is "false", the component will be hidden on the client. Unlike "rendered", this does not affect the lifecycle on the server - the component may have its bindings executed, etc. - and the visibility of the component can be toggled on and off on the client, or toggled with PPR. When "rendered" is false, the component will not in any way be rendered, and cannot be made visible on the client. In most cases, use the "rendered" property instead of the "visible" property.

Parameters:

visible - the new visible value

getCustomizationId

@Deprecated
public final String getCustomizationId()

Deprecated. This attribute is deprecated. This attribute will be removed in the next release. Use the 'id' attribute instead.

Gets This attribute is deprecated. The 'id' attribute should be used when applying persistent customizations. This attribute will be removed in the next release.

Returns:

the new customizationId value

setCustomizationId

@Deprecated
public final void setCustomizationId(String customizationId)

Deprecated. This attribute is deprecated. This attribute will be removed in the next release. Use the 'id' attribute instead.

Sets This attribute is deprecated. The 'id' attribute should be used when applying persistent customizations. This attribute will be removed in the next release.

Parameters:

customizationId - the new customizationId value

isClientComponent

public final boolean isClientComponent()

Gets whether a client-side component will be generated. A component may be generated whether or not this flag is set, but if client Javascript requires the component object, this must be set to true to guarantee the component's presence. Client component objects that are generated today by default may not be present in the future; setting this flag is the only way to guarantee a component's presence, and clients cannot rely on implicit behavior. However, there is a performance cost to setting this flag, so clients should avoid turning on client components unless absolutely necessary.

Returns:

the new clientComponent value

setClientComponent

public final void setClientComponent(boolean clientComponent)

Sets whether a client-side component will be generated. A component may be generated whether or not this flag is set, but if client Javascript requires the component object, this must be set to true to guarantee the component's presence. Client component objects that are generated today by default may not be present in the future; setting this flag is the only way to guarantee a component's presence, and clients cannot rely on implicit behavior. However, there is a performance cost to setting this flag, so clients should avoid turning on client components unless absolutely necessary.

Parameters:

clientComponent - the new clientComponent value

getClientAttributes

public final Set getClientAttributes()

Gets a set of client attribute names.

Returns:

the new clientAttributes value

setClientAttributes

public final void setClientAttributes(Set clientAttributes)

Sets a set of client attribute names.

Parameters:

clientAttributes - the new clientAttributes value

getPartialTriggers

public final String[] getPartialTriggers()

Gets the IDs of the components that should trigger a partial update. This component will listen on the trigger components. If one of the trigger components receives an event that will cause it to update in some way, this component will request to be updated too. Identifiers are relative to the source component (this component), and must account for NamingContainers. If your component is already inside of a naming container, you can use a single colon to start the search from the root of the page, or multiple colons to move up through the NamingContainers - "::" will pop out of the component's naming container (or itself if the component is a naming container) and begin the search from there, ":::" will pop out of two naming containers (including itself if the component is a naming container) and begin the search from there, etc.

Returns:

the new partialTriggers value

setPartialTriggers

public final void setPartialTriggers(String[] partialTriggers)

Sets the IDs of the components that should trigger a partial update. This component will listen on the trigger components. If one of the trigger components receives an event that will cause it to update in some way, this component will request to be updated too. Identifiers are relative to the source component (this component), and must account for NamingContainers. If your component is already inside of a naming container, you can use a single colon to start the search from the root of the page, or multiple colons to move up through the NamingContainers - "::" will pop out of the component's naming container (or itself if the component is a naming container) and begin the search from there, ":::" will pop out of two naming containers (including itself if the component is a naming container) and begin the search from there, etc.

Parameters:

partialTriggers - the new partialTriggers value

getClientListeners

public final ClientListenerSet getClientListeners()

Gets a set of client listeners.

Returns:

the new clientListeners value

setClientListeners

public final void setClientListeners(ClientListenerSet clientListeners)

Sets a set of client listeners.

Parameters:

clientListeners - the new clientListeners value

getDefaultEventName

public String getDefaultEventName()

Specified by:

getDefaultEventName in interface javax.faces.component.behavior.ClientBehaviorHolder

Overrides:

getDefaultEventName in class org.apache.myfaces.trinidad.component.UIXComponentBase

getEventNames

public Collection<String> getEventNames()

Specified by:

getEventNames in interface javax.faces.component.behavior.ClientBehaviorHolder

getClientBehaviors

public Map<String,List<javax.faces.component.behavior.ClientBehavior>> getClientBehaviors()

Specified by:

getClientBehaviors in interface javax.faces.component.behavior.ClientBehaviorHolder

Overrides:

getClientBehaviors in class org.apache.myfaces.trinidad.component.UIXComponentBase

addClientBehavior

public void addClientBehavior(String eventName,
                              javax.faces.component.behavior.ClientBehavior behavior)

Specified by:

addClientBehavior in interface javax.faces.component.behavior.ClientBehaviorHolder

Overrides:

addClientBehavior in class org.apache.myfaces.trinidad.component.UIXComponentBase

getFamily

public String getFamily()

Overrides:

getFamily in class PartialUIXQuery

getBeanType

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

Overrides:

getBeanType in class PartialUIXQuery

Skip navigation links