Skip navigation links

oracle.adf.view.rich.component.rich
Class RichQuickQuery

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.RichQuickQuery

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 RichQuickQuery

extends UIXQuery

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

The QuickQuery component enables a user to perform a quick search for a textual string against the selected criterion belonging to the QueryDescriptor as specified by the value property. The quickQuery component is a composite of other web components some rendered implicitly, others as specified by the facets of the component. The quickQuery component is usually used along with a table/treeTable component, that displays the results of the search. Developers can set the partialTriggers property of the the table component to the id of the quickQuery component, in order to see the results of the search, each time the user performs a query.
The following web components are generated as part of a quickQuery component.

Search Label

Search Label is specified using the label property on the quickquery Component and it is displayed at the beginning of quickQuery component as per the specified layout.

criteriaItems

This facet specifies a component that displays the list of criterion associated to the QueryDescriptor. Usually a select component is used for this purpose, but if the facet is not defined, a selectOneChoice component will be generated by default. Developers can use other components using this facet in which case they will be used in place of the selectOneChoice. Developers are responsible for wiring the value property to a valid QueryDescriptor instance and register a QueryListener that performs the query.

Criterion Value

Based on the criterion that is currently selected in the criteriaItems select component, a value component, appropriate for the type of the criterion, is dynamically rendered. For e.g., if the criterion selected happens to be of type Date, an inputDate component is rendered. A type Number yields a inputNumberSpinbox. For more information on how this is determined, refer to the QueryDescriptor, ConjunctionCriterion, AttributeCriterion and AttributeDescriptor model interfaces.
User enters a value that will be used in the search criteria.

Go Button

A Search icon link that allows the user to perform the search against the selected criterion using the value entered in the value component. This button will be made disabled if the descriptor is null (iow, 'value' property resolves to null) and no 'criterionValue' facet is specified, or if criteriaItems resolves to null.

end

This facet usually specifies a link component that is used to toggle between quickQuery and query component.

The following example explains the usage of quickQuery Component.

  <af:quickQuery label="Search" id="search" 
                 value="bean.queryDescriptor" 
                 queryListener="bean.processQuery">
     <f:facet name="end">
        <af:link text="Advanced"/>
     </f:facet>
  </af:quickQuery>
           

<section name="Geometry_Management"> <html:ul> <html:li>This component cannot be stretched by a parent layout component.</html:li> <html:li>This component does not have support for stretching its children.</html:li> </html:ul> </section>

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	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 String	CRITERIA_ITEMS_FACET
static org.apache.myfaces.trinidad.bean.PropertyKey	CUSTOMIZATION_ID_KEY Deprecated.
static String	END_FACET
static org.apache.myfaces.trinidad.bean.PropertyKey	HELP_TOPIC_ID_KEY
static org.apache.myfaces.trinidad.bean.PropertyKey	INLINE_STYLE_KEY
static org.apache.myfaces.trinidad.bean.PropertyKey	LABEL_KEY
static String	LAYOUT_HORIZONTAL
static org.apache.myfaces.trinidad.bean.PropertyKey	LAYOUT_KEY
static String	LAYOUT_VERTICAL
static org.apache.myfaces.trinidad.bean.PropertyKey	PARTIAL_TRIGGERS_KEY
static org.apache.myfaces.trinidad.bean.PropertyKey	SEARCH_DESC_KEY
static org.apache.myfaces.trinidad.bean.PropertyKey	SHORT_DESC_KEY
static org.apache.myfaces.trinidad.bean.PropertyKey	STYLE_CLASS_KEY
static org.apache.myfaces.trinidad.bean.FacesBean.Type	TYPE
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

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

Method Summary

void	addClientBehavior(String eventName, javax.faces.component.behavior.ClientBehavior behavior)
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.
javax.faces.component.UIComponent	getCriteriaItems() The component used to display a list of criterion.
String	getCustomizationId() Deprecated. This attribute is deprecated. This attribute will be removed in the next release. Use the 'id' attribute instead.
String	getDefaultEventName()
javax.faces.component.UIComponent	getEnd() The component to be displayed at the end of the quickQuery component.
Collection<String>	getEventNames()
String	getFamily()
String	getHelpTopicId() Gets the id used to look up a topic in a helpProvider.
String	getInlineStyle() Gets the CSS styles to use for this component.
String	getLabel() Gets the label of the quickQuery.
String	getLayout() Gets the type of layout.
String[]	getPartialTriggers() Gets the IDs of the components that should trigger a partial update.
String	getSearchDesc() Gets used to override the search description.
String	getShortDesc() Gets the short description of the component.
String	getStyleClass() Gets a CSS style class to use for this component.
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	isVisible() Gets the visibility of the component.
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	setCriteriaItems(javax.faces.component.UIComponent criteriaItemsFacet) The component used to display a list of criterion.
void	setCustomizationId(String customizationId) Deprecated. This attribute is deprecated. This attribute will be removed in the next release. Use the 'id' attribute instead.
void	setEnd(javax.faces.component.UIComponent endFacet) The component to be displayed at the end of the quickQuery component.
void	setHelpTopicId(String helpTopicId) Sets the id used to look up a topic in a helpProvider.
void	setInlineStyle(String inlineStyle) Sets the CSS styles to use for this component.
void	setLabel(String label) Sets the label of the quickQuery.
void	setLayout(String layout) Sets the type of layout.
void	setPartialTriggers(String[] partialTriggers) Sets the IDs of the components that should trigger a partial update.
void	setSearchDesc(String searchDesc) Sets used to override the search description.
void	setShortDesc(String shortDesc) Sets the short description of the component.
void	setStyleClass(String styleClass) Sets a CSS style class to use for this component.
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

LAYOUT_HORIZONTAL

public static final String LAYOUT_HORIZONTAL

See Also:

Constant Field Values

LAYOUT_VERTICAL

public static final String LAYOUT_VERTICAL

See Also:

Constant Field Values

TYPE

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

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

LABEL_KEY

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

HELP_TOPIC_ID_KEY

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

LAYOUT_KEY

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

SEARCH_DESC_KEY

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

CRITERIA_ITEMS_FACET

public static final String CRITERIA_ITEMS_FACET

See Also:

Constant Field Values

END_FACET

public static final String END_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

RichQuickQuery

public RichQuickQuery()

Construct an instance of the RichQuickQuery.

RichQuickQuery

protected RichQuickQuery(String rendererType)

Construct an instance of the RichQuickQuery.

Method Detail

getCriteriaItems

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

The component used to display a list of criterion. A select component can be specified and by default, if a criteriaItems facet is not defined, a selectOneChoice component is created. A quick search is performed against one of the criterion, using the values entered in "a dynamically generated" value component. Must be only one component, multiple components are not supported by this facet.

setCriteriaItems

public final void setCriteriaItems(javax.faces.component.UIComponent criteriaItemsFacet)

The component used to display a list of criterion. A select component can be specified and by default, if a criteriaItems facet is not defined, a selectOneChoice component is created. A quick search is performed against one of the criterion, using the values entered in "a dynamically generated" value component. Must be only one component, multiple components are not supported by this facet.

getEnd

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

The component to be displayed at the end of the quickQuery component. For e.g., it is used to display a link that toggles between quickQuery and query components, when component is configured using ADF-DT. Must be only one component, multiple components are not supported by this facet.

setEnd

public final void setEnd(javax.faces.component.UIComponent endFacet)

The component to be displayed at the end of the quickQuery component. For e.g., it is used to display a link that toggles between quickQuery and query components, when component is configured using ADF-DT. Must be only one component, multiple components are not supported by this facet.

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

getLabel

public final String getLabel()

Gets the label of the quickQuery.

Returns:

the new label value

setLabel

public final void setLabel(String label)

Sets the label of the quickQuery.

Parameters:

label - the new label 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

getLayout

public final String getLayout()

Gets the type of layout.

Returns:

the new layout value

setLayout

public final void setLayout(String layout)

Sets the type of layout.

Parameters:

layout - the new layout value

getSearchDesc

public final String getSearchDesc()

Gets used to override the search description. The search description appears in the tooltip when user does a mouseover on the Search icon. By default this value will be 'Search: ' followed by the label name. If a searchDesc is specified, that value is used instead.

Returns:

the new searchDesc value

setSearchDesc

public final void setSearchDesc(String searchDesc)

Sets used to override the search description. The search description appears in the tooltip when user does a mouseover on the Search icon. By default this value will be 'Search: ' followed by the label name. If a searchDesc is specified, that value is used instead.

Parameters:

searchDesc - the new searchDesc 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