com.arsdigita.search.ui
Class ResultsPane

java.lang.Object
  extended bycom.arsdigita.bebop.Completable
      extended bycom.arsdigita.bebop.SimpleComponent
          extended bycom.arsdigita.search.ui.ResultsPane
All Implemented Interfaces:
Cloneable, Component, Lockable

public class ResultsPane
extends SimpleComponent


Field Summary
static int PAGE_SIZE
           
 
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
ResultsPane(QueryGenerator query)
           
ResultsPane(QueryGenerator query, String engine)
           
 
Method Summary
protected  Element generateDocumentsXML(PageState state, Iterator results)
           
protected  Element generateDocumentXML(PageState state, Document doc)
           
protected  Element generatePaginatorXML(PageState state, String pageParam, int pageNumber, int pageCount, int pageSize, long begin, long end, long objectCount)
           
 void generateXML(PageState state, Element parent)
          Adds [J]DOM nodes for this component.
 void register(Page p)
          Registers state parameters for the page with its model.
 
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

PAGE_SIZE

public static final int PAGE_SIZE
See Also:
Constant Field Values
Constructor Detail

ResultsPane

public ResultsPane(QueryGenerator query)

ResultsPane

public ResultsPane(QueryGenerator query,
                   String engine)
Method Detail

register

public void register(Page p)
Description copied from interface: Component
Registers state parameters for the page with its model. A simple component with a state parameter param would do the following in the body of this method:
   p.addComponent(this);
   p.addComponentStateParam(this, param);
 
You should override this method to set the default visibility of your component:
 public void register(Page p) {
     super.register(p);
     p.setVisibleDefault(childNotInitiallyShown,false);
     p.setVisibleDefault(anotherChild, false);
 }
 
Always call super.register when you override register. Otherwise your component may malfunction and produce errors like "Widget ... isn't associated with any Form"

Specified by:
register in interface Component
Overrides:
register in class SimpleComponent

generateXML

public void generateXML(PageState state,
                        Element parent)
Description copied from class: SimpleComponent
Adds [J]DOM nodes for this component. Specifically for base class SimpleComponent, does nothing.

Specified by:
generateXML in interface Component
Overrides:
generateXML in class SimpleComponent

generatePaginatorXML

protected Element generatePaginatorXML(PageState state,
                                       String pageParam,
                                       int pageNumber,
                                       int pageCount,
                                       int pageSize,
                                       long begin,
                                       long end,
                                       long objectCount)

generateDocumentsXML

protected Element generateDocumentsXML(PageState state,
                                       Iterator results)

generateDocumentXML

protected Element generateDocumentXML(PageState state,
                                      Document doc)


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