com.arsdigita.cms.ui.authoring
Class BasicImageForm
java.lang.Object
com.arsdigita.bebop.Completable
com.arsdigita.bebop.SimpleComponent
com.arsdigita.bebop.FormSection
com.arsdigita.bebop.Form
com.arsdigita.cms.ui.authoring.BasicImageForm
- All Implemented Interfaces:
- com.arsdigita.bebop.util.BebopConstants, Cloneable, com.arsdigita.bebop.Component, com.arsdigita.bebop.Container, EventListener, com.arsdigita.bebop.event.FormInitListener, com.arsdigita.bebop.event.FormProcessListener, com.arsdigita.util.Lockable
- Direct Known Subclasses:
- ImagePropertiesForm, ImageSelectionForm, ImageUploadForm
- public abstract class BasicImageForm
- extends com.arsdigita.bebop.Form
- implements com.arsdigita.bebop.event.FormInitListener, com.arsdigita.bebop.event.FormProcessListener
A form for modifying a single image asset attached to the article.
This is just a convenience class; children should override
the addWidgets, init and process methods.
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, CLASS, ID, ON_CLICK, STYLE |
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 interface com.arsdigita.bebop.Component |
getClassAttr, getIdAttr, getKey, getStyleAttr, isVisible, setClassAttr, setIdAttr, setKey, setStyleAttr, setVisible |
Methods inherited from interface com.arsdigita.util.Lockable |
isLocked |
versionId
public static final String versionId
- See Also:
- Constant Field Values
CAPTION
public static final String CAPTION
- See Also:
- Constant Field Values
BasicImageForm
public BasicImageForm(String formName,
ItemSelectionModel itemModel,
ItemSelectionModel assetModel)
- Construct a new BasicImageForm
- Parameters:
formName
- The name for this formitemModel
- The ItemSelectionModel
which will
be responsible for loading the current itemassetModel
- The ItemSelectionModel
which will
be responsible for loading the current image asset
addWidgets
protected void addWidgets()
- Add various widgets to the form. Child classes should override
this method to perform all their widget-adding needs
init
public abstract void init(com.arsdigita.bebop.event.FormSectionEvent e)
throws com.arsdigita.bebop.FormProcessException
- Perform form initialization. Children should override this
this method to pre-fill the widgets with data, instantiate
the content item, etc.
- Specified by:
init
in interface com.arsdigita.bebop.event.FormInitListener
- Throws:
com.arsdigita.bebop.FormProcessException
process
public abstract void process(com.arsdigita.bebop.event.FormSectionEvent e)
throws com.arsdigita.bebop.FormProcessException
- Process the form. Children should override this method to save
the user's changes to the database.
- Specified by:
process
in interface com.arsdigita.bebop.event.FormProcessListener
- Throws:
com.arsdigita.bebop.FormProcessException
initCaption
public void initCaption(com.arsdigita.bebop.event.FormSectionEvent e)
- Helper method to pre-fill the "Caption" textbox. Should be called from
the init listener
- Parameters:
e
- The FormSectionEvent
processCaption
public void processCaption(com.arsdigita.bebop.event.FormSectionEvent e)
- Helper method to process "Caption" textbox. Should be called from
the process listener
- Parameters:
e
- The FormSectionEvent
getItemSelectionModel
public ItemSelectionModel getItemSelectionModel()
- Returns:
- the item selection model used in this form
getAssetSelectionModel
public ItemSelectionModel getAssetSelectionModel()
- Returns:
- the asset selection model used in this form
getSaveCancelSection
public com.arsdigita.bebop.SaveCancelSection getSaveCancelSection()
- Returns:
- the save/cancel section for this form
getArticle
public Article getArticle(com.arsdigita.bebop.PageState state)
- Parameters:
state
- The page state
- Returns:
- the currently selected item
getImageAsset
public ImageAsset getImageAsset(com.arsdigita.bebop.PageState state)
- Parameters:
state
- The page state
- Returns:
- the currently selected image asset
setImageAsset
public void setImageAsset(com.arsdigita.bebop.PageState state,
ImageAsset asset)
- Set the image asset. This will probably be done in the process
listener
- Parameters:
state
- The page stateasset
- The image asset
Copyright (c) 2004 Red Hat, Inc. Corporation. All Rights Reserved. Generated at July 21 2004:2352 UTC