com.arsdigita.cms.ui.type
Class ElementAddForm

java.lang.Object
  extended bycom.arsdigita.bebop.Completable
      extended bycom.arsdigita.bebop.SimpleComponent
          extended bycom.arsdigita.bebop.FormSection
              extended bycom.arsdigita.bebop.Form
                  extended bycom.arsdigita.cms.ui.CMSForm
                      extended bycom.arsdigita.cms.ui.type.ElementAddForm
All Implemented Interfaces:
com.arsdigita.bebop.util.BebopConstants, com.arsdigita.toolbox.ui.Cancellable, Cloneable, com.arsdigita.bebop.Component, com.arsdigita.bebop.Container, com.arsdigita.util.Lockable
Direct Known Subclasses:
AddContentItemElement, AddDateElement, AddFileElement, AddImageElement, AddNumberElement, AddTextAssetElement, AddTextElement

public abstract class ElementAddForm
extends CMSForm

This is the base form class for all ElementAddForms used in adding elements to a user-defined content type

Version:
$Revision: #18 $ $Date: 2004/04/07 $
Author:
Xixi D'Moon (xdmoon@arsdigita.com), Stanislav Freidin (sfreidin@arsdigita.com)

Field Summary
protected  com.arsdigita.bebop.SimpleContainer m_buttons
           
protected  com.arsdigita.bebop.form.Submit m_cancel
           
protected  com.arsdigita.bebop.form.TextField m_description
           
protected  com.arsdigita.bebop.form.Hidden m_id
           
protected  com.arsdigita.bebop.form.TextField m_label
           
protected  com.arsdigita.bebop.form.Submit m_submit
           
protected  com.arsdigita.kernel.ui.ACSObjectSelectionModel m_types
           
 
Fields inherited from class com.arsdigita.cms.ui.CMSForm
CLASS, versionId
 
Fields inherited from class com.arsdigita.bebop.Form
GET, POST
 
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.util.BebopConstants
BEBOP_BORDER, BEBOP_BOXPANEL, BEBOP_CELL, BEBOP_CHECKBOX, BEBOP_CHECKBOXGROUP, BEBOP_COLUMNPANEL, BEBOP_DATE, BEBOP_DATETIME, BEBOP_DHTMLEDITOR, BEBOP_FORMERRORS, BEBOP_FORMWIDGET, BEBOP_GRIDPANEL, BEBOP_LIST, BEBOP_MULTISELECT, BEBOP_OPTION, BEBOP_PAD, BEBOP_PADFRAME, BEBOP_PANELROW, BEBOP_PORTAL, BEBOP_PORTLET, BEBOP_RADIO, BEBOP_RADIOGROUP, BEBOP_SEG_BODY, BEBOP_SEG_HEADER, BEBOP_SEG_PANEL, BEBOP_SEGMENT, BEBOP_SELECT, BEBOP_TABLE, BEBOP_TABLEBODY, BEBOP_TABLEROW, BEBOP_TEXTAREA
 
Fields inherited from interface com.arsdigita.bebop.Component
BEBOP_XML_NS, ID, ON_CLICK, STYLE
 
Constructor Summary
ElementAddForm(String formName, String titleLabel, com.arsdigita.kernel.ui.ACSObjectSelectionModel m)
          Constructor.
 
Method Summary
protected abstract  void addAttribute(com.arsdigita.metadata.DynamicObjectType dot, String label, com.arsdigita.bebop.PageState state)
          Adds an attribute to the passed in dynamic object type.
protected abstract  void addFormComponent(com.arsdigita.formbuilder.PersistentForm pForm, String label, com.arsdigita.bebop.PageState state)
          Adds a persistent form component (or components) to the passed in persistent form.
protected  void addLabelDescript(com.arsdigita.formbuilder.PersistentForm pForm, String label, String description)
          adds an label and description field for an attribute to the persistent form used to author items of this udct
protected  void doInit(com.arsdigita.bebop.event.FormSectionEvent event)
          Subclasses should override this method if they wish do perform initialization actions in addition to those performed by ElementAddForm.
protected  void doValidate(com.arsdigita.bebop.event.FormSectionEvent event)
          Subclasses should override this method if they wish do perform validation actions in addition to those already performed by ElementAddForm.
protected  com.arsdigita.bebop.SimpleContainer getButtons()
           
protected  com.arsdigita.bebop.form.Submit getCancel()
           
protected  ContentType getContentType(com.arsdigita.bebop.PageState state)
          Fetches the currently selected content type from the single selection model.
protected  com.arsdigita.bebop.form.TextField getDescriptionField()
           
protected  com.arsdigita.metadata.DynamicObjectType getDOT(ContentType type)
          Fetches the associated object type of a user defined content type
protected  com.arsdigita.bebop.form.Hidden getHiddenID()
           
protected  com.arsdigita.bebop.form.TextField getLabelField()
           
protected  com.arsdigita.kernel.ui.ACSObjectSelectionModel getSelectionModel()
           
protected  com.arsdigita.bebop.form.Submit getSubmit()
           
 boolean isCancelled(com.arsdigita.bebop.PageState s)
          if this form is cancelled
protected  void refreshAuthoring(com.arsdigita.bebop.PageState state)
          drops the bebop page to refresh authoring ui
 
Methods inherited from class com.arsdigita.bebop.Form
addMagicTag, excludeParameterFromExport, generateErrors, generateXML, generateXMLSansState, getAction, getFormData, getName, getProcessInvisible, isRedirecting, process, register, respond, setAction, setEncType, setFormData, setMethod, setName, setOnReset, setOnSubmit, setProcessInvisible, setRedirecting, toString, traverse
 
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, get, getModel, getPanel, indexOf, isEmpty, lock, register, removeCancelListener, removeInitListener, removeProcessListener, removeSubmissionListener, removeValidationListener, 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, 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

m_types

protected final com.arsdigita.kernel.ui.ACSObjectSelectionModel m_types

m_id

protected com.arsdigita.bebop.form.Hidden m_id

m_label

protected com.arsdigita.bebop.form.TextField m_label

m_description

protected com.arsdigita.bebop.form.TextField m_description

m_buttons

protected com.arsdigita.bebop.SimpleContainer m_buttons

m_submit

protected com.arsdigita.bebop.form.Submit m_submit

m_cancel

protected com.arsdigita.bebop.form.Submit m_cancel
Constructor Detail

ElementAddForm

public ElementAddForm(String formName,
                      String titleLabel,
                      com.arsdigita.kernel.ui.ACSObjectSelectionModel m)
Constructor. Creates a new form that lets user add an element to a content type

Parameters:
formName - The name of the form
titleLabel - The form title to be displayed at the very top
m - The ACSObjectSelectionModel indicating the current content type
Method Detail

getSelectionModel

protected com.arsdigita.kernel.ui.ACSObjectSelectionModel getSelectionModel()

getHiddenID

protected com.arsdigita.bebop.form.Hidden getHiddenID()

getLabelField

protected com.arsdigita.bebop.form.TextField getLabelField()

getDescriptionField

protected com.arsdigita.bebop.form.TextField getDescriptionField()

getButtons

protected com.arsdigita.bebop.SimpleContainer getButtons()

getSubmit

protected com.arsdigita.bebop.form.Submit getSubmit()

getCancel

protected com.arsdigita.bebop.form.Submit getCancel()

addAttribute

protected abstract void addAttribute(com.arsdigita.metadata.DynamicObjectType dot,
                                     String label,
                                     com.arsdigita.bebop.PageState state)
                              throws com.arsdigita.bebop.FormProcessException
Adds an attribute to the passed in dynamic object type. Used by the internal FormProcessListener.process(FormSectionEvent).

Throws:
com.arsdigita.bebop.FormProcessException
See Also:
FormProcessListener.process(FormSectionEvent)

addFormComponent

protected abstract void addFormComponent(com.arsdigita.formbuilder.PersistentForm pForm,
                                         String label,
                                         com.arsdigita.bebop.PageState state)
                                  throws com.arsdigita.bebop.FormProcessException
Adds a persistent form component (or components) to the passed in persistent form. Used by the internal FormProcessListener.process(FormSectionEvent).

Throws:
com.arsdigita.bebop.FormProcessException
See Also:
FormProcessListener.process(FormSectionEvent)

isCancelled

public boolean isCancelled(com.arsdigita.bebop.PageState s)
if this form is cancelled

Specified by:
isCancelled in interface com.arsdigita.toolbox.ui.Cancellable
Overrides:
isCancelled in class CMSForm
Parameters:
s - The page state
Returns:
True if form is cancelled, false otherwise

doInit

protected void doInit(com.arsdigita.bebop.event.FormSectionEvent event)
Subclasses should override this method if they wish do perform initialization actions in addition to those performed by ElementAddForm.


doValidate

protected void doValidate(com.arsdigita.bebop.event.FormSectionEvent event)
                   throws com.arsdigita.bebop.FormProcessException
Subclasses should override this method if they wish do perform validation actions in addition to those already performed by ElementAddForm.

Throws:
com.arsdigita.bebop.FormProcessException

getContentType

protected ContentType getContentType(com.arsdigita.bebop.PageState state)
Fetches the currently selected content type from the single selection model.

Parameters:
state - The page state
Returns:
The current content type

getDOT

protected com.arsdigita.metadata.DynamicObjectType getDOT(ContentType type)
Fetches the associated object type of a user defined content type

Parameters:
type - The udct
Returns:
The associated dynamic object type

refreshAuthoring

protected void refreshAuthoring(com.arsdigita.bebop.PageState state)
drops the bebop page to refresh authoring ui

Parameters:
state - The page state

addLabelDescript

protected void addLabelDescript(com.arsdigita.formbuilder.PersistentForm pForm,
                                String label,
                                String description)
adds an label and description field for an attribute to the persistent form used to author items of this udct

Parameters:
pForm - The persistent form
label - Label of the element
description - Description of the element


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