com.arsdigita.search.ui.filters
Class PartyFilterWidget

java.lang.Object
  extended bycom.arsdigita.bebop.Completable
      extended bycom.arsdigita.bebop.SimpleComponent
          extended bycom.arsdigita.search.ui.FilterComponent
              extended bycom.arsdigita.search.ui.FilterWidget
                  extended bycom.arsdigita.search.ui.filters.PartyFilterWidget
All Implemented Interfaces:
Cloneable, Component, FilterGenerator, Lockable

public class PartyFilterWidget
extends FilterWidget

This is a base widget that can be used to restrict a search to a certain group of users.


Field Summary
static String PARTY_TEXT
           
 
Fields inherited from class com.arsdigita.bebop.SimpleComponent
m_attr, versionId
 
Fields inherited from interface com.arsdigita.bebop.Component
BEBOP_XML_NS, CLASS, ID, ON_CLICK, STYLE
 
Constructor Summary
PartyFilterWidget(FilterType type, String parameterName)
          This creates a text field that can be used to restrict the results by user.
 
Method Summary
 void generateBodyXML(PageState state, Element parent)
          The impl of this methods adds information about any validation errors to the output.
 FilterSpecification getFilter(PageState state)
          Returns the current filter specification
 
Methods inherited from class com.arsdigita.search.ui.FilterWidget
generateErrorXML, getForm, getParameter, getValue, register
 
Methods inherited from class com.arsdigita.search.ui.FilterComponent
generateXML
 
Methods inherited from class com.arsdigita.bebop.SimpleComponent
children, clone, exportAttributes, getAttribute, getClassAttr, getIdAttr, getKey, getMetaDataAttribute, getStyleAttr, hasAttributes, isLocked, isVisible, lock, register, respond, setAttribute, setClassAttr, setIdAttr, setKey, setMetaDataAttribute, setStyleAttr, setVisible
 
Methods inherited from class com.arsdigita.bebop.Completable
addCompletionListener, fireCompletionEvent
 
Methods inherited from class java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

PARTY_TEXT

public static final String PARTY_TEXT
See Also:
Constant Field Values
Constructor Detail

PartyFilterWidget

public PartyFilterWidget(FilterType type,
                         String parameterName)
This creates a text field that can be used to restrict the results by user. The passed in is used for the parameter that holds the user input party informaiton

Method Detail

getFilter

public FilterSpecification getFilter(PageState state)
Description copied from interface: FilterGenerator
Returns the current filter specification

Returns:
a filter specification

generateBodyXML

public void generateBodyXML(PageState state,
                            Element parent)
Description copied from class: FilterWidget
The impl of this methods adds information about any validation errors to the output. If overriding this method, you must call super.generateBodyXML.

Overrides:
generateBodyXML in class FilterWidget


Copyright (c) 2004 Red Hat, Inc. Corporation. All Rights Reserved. Generated at July 20 2004:2337 UTC