com.arsdigita.cms.ui
Class UserAddForm

java.lang.Object
  extended bycom.arsdigita.bebop.Completable
      extended bycom.arsdigita.bebop.SimpleComponent
          extended bycom.arsdigita.bebop.TextStylable
              extended bycom.arsdigita.bebop.BlockStylable
                  extended bycom.arsdigita.bebop.SimpleContainer
                      extended bycom.arsdigita.cms.ui.UserAddForm
All Implemented Interfaces:
Cloneable, com.arsdigita.bebop.Component, com.arsdigita.bebop.Container, EventListener, com.arsdigita.bebop.event.FormProcessListener, com.arsdigita.util.Lockable
Direct Known Subclasses:
ObjectAddAdmin

public abstract class UserAddForm
extends com.arsdigita.bebop.SimpleContainer
implements com.arsdigita.bebop.event.FormProcessListener

Form for adding multiple users to a role.

Version:
$Revision: #18 $ $DateTime: 2004/04/07 16:07:11 $
Author:
Michael Pih (pihman@arsdigita.com), Uday Mathur (umathur@arsdigita.com)

Field Summary
static String versionId
           
 
Fields inherited from class com.arsdigita.bebop.BlockStylable
ABSBOTTOM, ABSMIDDLE, BASELINE, BOTTOM, CENTER, FULL_WIDTH, INSERT, LEFT, MIDDLE, RIGHT, TEXTTOP, TOP
 
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
UserAddForm(com.arsdigita.bebop.form.Widget search)
          Constructor.
UserAddForm(com.arsdigita.bebop.form.Widget search, String name)
           
UserAddForm(com.arsdigita.bebop.form.Widget search, String name, String text, String submitText)
           
 
Method Summary
protected  void addUsers(com.arsdigita.bebop.PageState state, com.arsdigita.bebop.form.OptionGroup target)
          Adds users to the option group.
 void generateXML(com.arsdigita.bebop.PageState state, com.arsdigita.xml.Element parent)
          Displays the appropriate frame.
 com.arsdigita.bebop.Form getForm()
          Fetches the form for adding users.
protected  com.arsdigita.bebop.form.Widget getSearchWidget()
          Fetches the widget that contains the search string.
 boolean isCancelled(com.arsdigita.bebop.PageState state)
          Return true if the form is cancelled, false otherwise.
protected  com.arsdigita.bebop.Form makeForm(String name)
          Build the form used to add users.
protected abstract  com.arsdigita.persistence.DataQuery makeQuery(com.arsdigita.bebop.PageState state)
          Generates a DataQuery that encapsulates search results.
abstract  void process(com.arsdigita.bebop.event.FormSectionEvent event)
          Process listener for the "Add users" form.
 
Methods inherited from class com.arsdigita.bebop.SimpleContainer
add, add, children, contains, generateChildrenXML, generateParent, get, getNamespace, getTag, indexOf, isEmpty, setNamespace, setTag, size
 
Methods inherited from class com.arsdigita.bebop.BlockStylable
setBorder, setBorder, setBorderColor, setHorizontalAlignment, setMargin, setMargin, setPadding, setPadding, setVerticalAlignment
 
Methods inherited from class com.arsdigita.bebop.TextStylable
setBackgroundColor, setColor
 
Methods inherited from class com.arsdigita.bebop.SimpleComponent
clone, exportAttributes, getAttribute, getClassAttr, getIdAttr, getKey, getMetaDataAttribute, getStyleAttr, hasAttributes, isLocked, isVisible, lock, register, 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
 
Methods inherited from interface com.arsdigita.bebop.Component
getClassAttr, getIdAttr, getKey, getStyleAttr, isVisible, register, register, respond, setClassAttr, setIdAttr, setKey, setStyleAttr, setVisible
 
Methods inherited from interface com.arsdigita.util.Lockable
isLocked, lock
 

Field Detail

versionId

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

UserAddForm

public UserAddForm(com.arsdigita.bebop.form.Widget search)
Constructor.

Parameters:
search - The widget on the search form that contains the value of the search string.

UserAddForm

public UserAddForm(com.arsdigita.bebop.form.Widget search,
                   String name)

UserAddForm

public UserAddForm(com.arsdigita.bebop.form.Widget search,
                   String name,
                   String text,
                   String submitText)
Method Detail

makeForm

protected com.arsdigita.bebop.Form makeForm(String name)
Build the form used to add users.

Returns:
The form

getForm

public com.arsdigita.bebop.Form getForm()
Fetches the form for adding users.

Returns:
The "add user" form

getSearchWidget

protected com.arsdigita.bebop.form.Widget getSearchWidget()
Fetches the widget that contains the search string.

Returns:
The widget that contains the search string

isCancelled

public boolean isCancelled(com.arsdigita.bebop.PageState state)
Return true if the form is cancelled, false otherwise.

Parameters:
state - The page state
Returns:
true if the form is cancelled, false otherwise.

addUsers

protected void addUsers(com.arsdigita.bebop.PageState state,
                        com.arsdigita.bebop.form.OptionGroup target)
Adds users to the option group.

Parameters:
state - The page state
target - The option group

makeQuery

protected abstract com.arsdigita.persistence.DataQuery makeQuery(com.arsdigita.bebop.PageState state)
Generates a DataQuery that encapsulates search results.

Parameters:
state - The page state

process

public abstract void process(com.arsdigita.bebop.event.FormSectionEvent event)
                      throws com.arsdigita.bebop.FormProcessException
Process listener for the "Add users" form.

Specified by:
process in interface com.arsdigita.bebop.event.FormProcessListener
Parameters:
event - The form event
Throws:
com.arsdigita.bebop.FormProcessException

generateXML

public void generateXML(com.arsdigita.bebop.PageState state,
                        com.arsdigita.xml.Element parent)
Displays the appropriate frame.

Specified by:
generateXML in interface com.arsdigita.bebop.Component
Parameters:
state - The page state
parent - The parent DOM element


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