com.arsdigita.cms.ui
Class ItemSearchSection

java.lang.Object
  extended bycom.arsdigita.bebop.Completable
      extended bycom.arsdigita.bebop.SimpleComponent
          extended bycom.arsdigita.bebop.FormSection
              extended bycom.arsdigita.cms.ui.ItemSearchSection
All Implemented Interfaces:
Cloneable, com.arsdigita.bebop.Component, com.arsdigita.bebop.Container, com.arsdigita.util.Lockable, com.arsdigita.search.ui.QueryGenerator, com.arsdigita.bebop.Resettable
Direct Known Subclasses:
ItemSearchSectionInline

public class ItemSearchSection
extends com.arsdigita.bebop.FormSection
implements com.arsdigita.bebop.Resettable, com.arsdigita.search.ui.QueryGenerator

Contains a form for specifying search parameters, as well as a ResultsPane which will perform the search and display the results

Version:
$Id: //cms/dev/src/com/arsdigita/cms/ui/ItemSearchSection.java#11 $
Author:
Stanislav Freidin (sfreidin@arsdigita.com)

Field Summary
static String SINGLE_TYPE_PARAM
           
static String versionId
           
 
Fields inherited from class com.arsdigita.bebop.FormSection
m_formModel, m_panel
 
Fields inherited from class com.arsdigita.bebop.SimpleComponent
m_attr
 
Fields inherited from interface com.arsdigita.bebop.Component
BEBOP_XML_NS, CLASS, ID, ON_CLICK, STYLE
 
Constructor Summary
ItemSearchSection(String context)
          Construct a new ItemSearchSection component
ItemSearchSection(String name, String context)
          Construct a new ItemSearchSection component
 
Method Summary
protected  void addFormListener()
           
protected  void addQueryGenerator(com.arsdigita.bebop.Container container)
           
protected  void addResultsPane(com.arsdigita.bebop.Container container)
           
protected  ItemQueryComponent createQueryGenerator(String context)
           
protected  com.arsdigita.bebop.Component createResultsPane(com.arsdigita.search.ui.QueryGenerator generator)
           
 com.arsdigita.search.QuerySpecification getQuerySpecification(com.arsdigita.bebop.PageState state)
           
 boolean hasQuery(com.arsdigita.bebop.PageState state)
           
protected  void processQuery(com.arsdigita.bebop.PageState state)
           
 void register(com.arsdigita.bebop.Page p)
           
 void reset(com.arsdigita.bebop.PageState state)
           
 
Methods inherited from class com.arsdigita.bebop.FormSection
add, add, addCancelListener, addInitListener, addProcessListener, addSubmissionListener, addValidationListener, children, contains, createInitListener, createProcessListener, createSubmissionListener, createValidationListener, fireCancel, fireInit, fireProcess, fireSubmitted, fireValidate, forwardInit, forwardProcess, forwardSubmission, forwardValidation, generateXML, get, getModel, getPanel, indexOf, isEmpty, lock, process, register, removeCancelListener, removeInitListener, removeProcessListener, removeSubmissionListener, removeValidationListener, respond, size
 
Methods inherited from class com.arsdigita.bebop.SimpleComponent
clone, exportAttributes, getAttribute, getClassAttr, getIdAttr, getKey, getMetaDataAttribute, getStyleAttr, hasAttributes, isLocked, isVisible, 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
 
Methods inherited from interface com.arsdigita.bebop.Component
getClassAttr, getIdAttr, getKey, getStyleAttr, isVisible, setClassAttr, setIdAttr, setKey, setStyleAttr, setVisible
 
Methods inherited from interface com.arsdigita.util.Lockable
isLocked
 

Field Detail

versionId

public static final String versionId
See Also:
Constant Field Values

SINGLE_TYPE_PARAM

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

ItemSearchSection

public ItemSearchSection(String context)
Construct a new ItemSearchSection component

Parameters:
context - the context for the retrieved items. Should be ContentItem.DRAFT or ContentItem.LIVE

ItemSearchSection

public ItemSearchSection(String name,
                         String context)
Construct a new ItemSearchSection component

Parameters:
context - the context for the retrieved items. Should be ContentItem.DRAFT or ContentItem.LIVE
name - The name of the search parameter for the particular FormSection
Method Detail

hasQuery

public boolean hasQuery(com.arsdigita.bebop.PageState state)
Specified by:
hasQuery in interface com.arsdigita.search.ui.QueryGenerator

getQuerySpecification

public com.arsdigita.search.QuerySpecification getQuerySpecification(com.arsdigita.bebop.PageState state)
Specified by:
getQuerySpecification in interface com.arsdigita.search.ui.QueryGenerator

reset

public void reset(com.arsdigita.bebop.PageState state)
Specified by:
reset in interface com.arsdigita.bebop.Resettable

createQueryGenerator

protected ItemQueryComponent createQueryGenerator(String context)

createResultsPane

protected com.arsdigita.bebop.Component createResultsPane(com.arsdigita.search.ui.QueryGenerator generator)

addResultsPane

protected void addResultsPane(com.arsdigita.bebop.Container container)

addQueryGenerator

protected void addQueryGenerator(com.arsdigita.bebop.Container container)

processQuery

protected void processQuery(com.arsdigita.bebop.PageState state)

addFormListener

protected void addFormListener()

register

public void register(com.arsdigita.bebop.Page p)
Specified by:
register in interface com.arsdigita.bebop.Component


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