com.arsdigita.kernel.ui
Class PartySearchSelect.Search
java.lang.Object
com.arsdigita.bebop.Completable
com.arsdigita.bebop.CompoundComponent
com.arsdigita.kernel.ui.PartySearchSelect.Search
- All Implemented Interfaces:
- Component, Lockable
- Enclosing class:
- PartySearchSelect
- public static class PartySearchSelect.Search
- extends CompoundComponent
A search form for searching a set of parties by name/email fragment.
Methods inherited from class com.arsdigita.bebop.CompoundComponent |
add, add, children, contains, generateXML, get, getClassAttr, getContainer, getIdAttr, getKey, getStyleAttr, indexOf, isEmpty, isLocked, isVisible, lock, register, register, respond, setClassAttr, setIdAttr, setKey, setStyleAttr, setVisible, size |
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
PartySearchSelect.Search
public PartySearchSelect.Search()
- Construct a search component for searching all parties in
the system.
PartySearchSelect.Search
public PartySearchSelect.Search(RequestLocal basePartyCollection)
- Construct a search component for searching within the specified
party collection.
setBaseQuery
public void setBaseQuery(PageState ps,
PartyCollection parties)
- Specifies the set of parties within which the user will search.
Mainly useful in conjunction with addFormSection(FormSection).
getSearchQuery
public PartyCollection getSearchQuery(PageState ps)
- Returns the collection of parties mathing the user's search
criteria.
addFormSection
public void addFormSection(FormSection formSection)
- Adds a form section to the search form, used to provide
additional UI for filtering/controlling the search results.
The process listener of the form section can use
getSearchQuery(PageState) in order to get the base search query
and add filters to it. Alternatively, the process listener can
use setBaseQuery(PageState, PartyCollection) to set the base
query from scratch.
Copyright (c) 2004 Red Hat, Inc. Corporation. All Rights Reserved. Generated at July 20 2004:2337 UTC