com.arsdigita.search.ui.filters
Class CategoryFilterWidget

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.CategoryFilterWidget
All Implemented Interfaces:
Cloneable, Component, FilterGenerator, Lockable
Direct Known Subclasses:
SimpleCategoryFilterWidget

public abstract class CategoryFilterWidget
extends FilterWidget

A base component for presenting a list of categories for filtering. This class needs to be subclassed to implement the method for generating the list of categories


Field Summary
 
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
CategoryFilterWidget()
          Creates a new category filter component
 
Method Summary
 void generateBodyXML(PageState state, Element parent)
          The impl of this methods adds information about any validation errors to the output.
abstract  Category[] getCategories(PageState state)
          Returns a list of categories to display for selection
 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
 

Constructor Detail

CategoryFilterWidget

public CategoryFilterWidget()
Creates a new category filter component

Method Detail

getFilter

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

Returns:
a filter specification

getCategories

public abstract Category[] getCategories(PageState state)
Returns a list of categories to display for selection


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