Docjar: A Java Source and Docuemnt Enginecom.*    java.*    javax.*    org.*    all    new    plug-in

Quick Search    Search Deep

ru.gammalabs.ice.presentation.web.publish
Class EditIEFormBean  view EditIEFormBean download EditIEFormBean.java

java.lang.Object
  extended byorg.apache.struts.action.ActionForm
      extended byru.gammalabs.ice.presentation.web.publish.EditIEFormBean
All Implemented Interfaces:
java.io.Serializable

public class EditIEFormBean
extends org.apache.struts.action.ActionForm

Bean for ie editor form capable of handling arbitrary fields number and types in ie.


Field Summary
private  java.lang.String deleteButton
           
private  java.util.Map editorBeans
           
static long EMPTY_ID
           
static java.lang.String EMPTY_ID_TEXT
           
static long EMPTY_TYPE_ID
           
private  java.lang.String idText
           
private  long ieId
           
private static org.apache.log4j.Category LOG
           
private  int mode
          The mode in which the bean works.
private static int MODE_PRIORITY_TO_BEAN
          Mode when
private static int MODE_PRIORITY_TO_PAGE
           
private  java.lang.String previewButton
           
private  java.lang.String saveButton
           
private  boolean sendNotifications
           
private  long typeId
           
private  java.lang.String typeName
           
 
Fields inherited from class org.apache.struts.action.ActionForm
multipartRequestHandler, servlet
 
Constructor Summary
EditIEFormBean()
           
 
Method Summary
 boolean doesAnyFieldEditorWantFormReload()
          Checks whether at least ine field editor wants the ie edit form to be reloaded.
 void fillFormFromIE(ru.gammalabs.ice.publishing.IE ie, ru.gammalabs.ice.presentation.web.SessionData sessionData, org.apache.struts.util.MessageResources messageResources, boolean preserveCurrentValues)
          Fill the fields of this form with the values from the given ie object Also fills the status list.
 java.util.List fillIEFromForm(ru.gammalabs.ice.publishing.IE ie, ru.gammalabs.ice.presentation.web.SessionData sessionData)
          Fill the given IE object with values given by the inputs in this formBean Also updates locales list of ie.
(package private)  ru.gammalabs.ice.publishing.AbstractIF getByIFType(ru.gammalabs.ice.iemanagement.IFType type, ru.gammalabs.ice.presentation.web.SessionData sessionData, ru.gammalabs.ice.publishing.IE ie)
           
 java.lang.String getDeleteButton()
           
 ru.gammalabs.ice.presentation.web.publish.editors.AbstractFieldEditFormBean getFieldEditorBean(int fieldId)
          Wrapper for getFieldEditorBean(long) method to conform with JavaBeans specification.
 ru.gammalabs.ice.presentation.web.publish.editors.AbstractFieldEditFormBean getFieldEditorBean(long fieldId)
          Indexed getter to acces editor beans by field index.
 java.lang.String getIdText()
           
 long getIeId()
           
 int getMode()
           
 java.lang.String getPreviewButton()
           
 java.lang.String getSaveButton()
           
 long getTypeId()
           
 java.lang.String getTypeName()
           
 boolean isEditingCreatedIE()
          Does this form serve to edit newly created IE? Checks whether valid id for IEType is apecified in form.
 boolean isEditingExistingIE()
          Does this form serve to edit exisiting IE? Checks whether valid id for IE is apecified in form.
 boolean isFieldPresent(long fieldId)
          Check whether the specified field exists in ie
 boolean isSendNotifications()
           
 void reset(org.apache.struts.action.ActionMapping mapping, javax.servlet.http.HttpServletRequest request)
          Reset bean properties to their default state, as needed.
(package private)  void setByIFType(ru.gammalabs.ice.iemanagement.IFType type, ru.gammalabs.ice.publishing.AbstractIF abstractIF, boolean isMandatory, long maxLength, ru.gammalabs.ice.presentation.web.SessionData sessionData, boolean preserveCurrentValue)
          Set arbitrary form field by giving abstract ie field value.
 void setDeleteButton(java.lang.String deleteButton)
           
private  void setFieldEditorBean(ru.gammalabs.ice.publishing.framework.Id fieldId, ru.gammalabs.ice.presentation.web.publish.editors.AbstractFieldEditFormBean bean)
          Sets field editor bean for specified field.
 void setIdText(java.lang.String idText)
           
 void setIeId(long ieId)
           
 void setMode(int mode)
           
 void setPreviewButton(java.lang.String previewButton)
           
 void setSaveButton(java.lang.String saveButton)
           
 void setSendNotifications(boolean sendNotifications)
           
 void setTypeId(long typeId)
           
 void setTypeName(java.lang.String typeName)
           
 org.apache.struts.action.ActionErrors validate(org.apache.struts.action.ActionMapping mapping, javax.servlet.http.HttpServletRequest request)
          Validate the properties that have been set for this HTTP request, and return an ActionErrors object that encapsulates any validation errors that have been found.
 
Methods inherited from class org.apache.struts.action.ActionForm
getMultipartRequestHandler, getServlet, getServletWrapper, reset, setMultipartRequestHandler, setServlet, validate
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

LOG

private static org.apache.log4j.Category LOG

ieId

private long ieId

EMPTY_ID

public static final long EMPTY_ID
See Also:
Constant Field Values

EMPTY_ID_TEXT

public static final java.lang.String EMPTY_ID_TEXT
See Also:
Constant Field Values

idText

private java.lang.String idText

typeId

private long typeId

EMPTY_TYPE_ID

public static final long EMPTY_TYPE_ID
See Also:
Constant Field Values

typeName

private java.lang.String typeName

previewButton

private java.lang.String previewButton

deleteButton

private java.lang.String deleteButton

saveButton

private java.lang.String saveButton

editorBeans

private java.util.Map editorBeans

mode

private int mode
The mode in which the bean works.


MODE_PRIORITY_TO_BEAN

private static final int MODE_PRIORITY_TO_BEAN
Mode when

See Also:
Constant Field Values

MODE_PRIORITY_TO_PAGE

private static final int MODE_PRIORITY_TO_PAGE
See Also:
Constant Field Values

sendNotifications

private boolean sendNotifications
Constructor Detail

EditIEFormBean

public EditIEFormBean()
Method Detail

getPreviewButton

public java.lang.String getPreviewButton()

setPreviewButton

public void setPreviewButton(java.lang.String previewButton)

getDeleteButton

public java.lang.String getDeleteButton()

setDeleteButton

public void setDeleteButton(java.lang.String deleteButton)

getSaveButton

public java.lang.String getSaveButton()

setSaveButton

public void setSaveButton(java.lang.String saveButton)

getIeId

public long getIeId()

setIeId

public void setIeId(long ieId)

getIdText

public java.lang.String getIdText()

setIdText

public void setIdText(java.lang.String idText)

getTypeName

public java.lang.String getTypeName()

setTypeName

public void setTypeName(java.lang.String typeName)

getMode

public int getMode()

setMode

public void setMode(int mode)

getTypeId

public long getTypeId()

setTypeId

public void setTypeId(long typeId)

getFieldEditorBean

public ru.gammalabs.ice.presentation.web.publish.editors.AbstractFieldEditFormBean getFieldEditorBean(int fieldId)
                                                                                               throws ru.gammalabs.ice.publishing.framework.NoSuchFieldInIeTypeException
Wrapper for getFieldEditorBean(long) method to conform with JavaBeans specification. Used by


getFieldEditorBean

public ru.gammalabs.ice.presentation.web.publish.editors.AbstractFieldEditFormBean getFieldEditorBean(long fieldId)
                                                                                               throws ru.gammalabs.ice.publishing.framework.NoSuchFieldInIeTypeException
Indexed getter to acces editor beans by field index.


setFieldEditorBean

private void setFieldEditorBean(ru.gammalabs.ice.publishing.framework.Id fieldId,
                                ru.gammalabs.ice.presentation.web.publish.editors.AbstractFieldEditFormBean bean)
Sets field editor bean for specified field.


isFieldPresent

public boolean isFieldPresent(long fieldId)
Check whether the specified field exists in ie


setByIFType

void setByIFType(ru.gammalabs.ice.iemanagement.IFType type,
                 ru.gammalabs.ice.publishing.AbstractIF abstractIF,
                 boolean isMandatory,
                 long maxLength,
                 ru.gammalabs.ice.presentation.web.SessionData sessionData,
                 boolean preserveCurrentValue)
           throws ru.gammalabs.ice.publishing.framework.CMSException,
                  ru.gammalabs.ice.presentation.web.ActionException
Set arbitrary form field by giving abstract ie field value.


getByIFType

ru.gammalabs.ice.publishing.AbstractIF getByIFType(ru.gammalabs.ice.iemanagement.IFType type,
                                                   ru.gammalabs.ice.presentation.web.SessionData sessionData,
                                                   ru.gammalabs.ice.publishing.IE ie)
                                             throws FieldValueWasNotSetInForm,
                                                    ru.gammalabs.ice.presentation.web.ActionException,
                                                    ru.gammalabs.ice.publishing.framework.CMSException

validate

public org.apache.struts.action.ActionErrors validate(org.apache.struts.action.ActionMapping mapping,
                                                      javax.servlet.http.HttpServletRequest request)
Validate the properties that have been set for this HTTP request, and return an ActionErrors object that encapsulates any validation errors that have been found. If no errors are found, return null or an ActionErrors object with no recorded error messages.

The default ipmlementation performs no validation and returns null. Subclasses must override this method to provide any validation they wish to perform.


reset

public void reset(org.apache.struts.action.ActionMapping mapping,
                  javax.servlet.http.HttpServletRequest request)
Description copied from class: org.apache.struts.action.ActionForm

Reset bean properties to their default state, as needed. This method is called before the properties are repopulated by the controller.

The default implementation does nothing. In practice, the only properties that need to be reset are those which represent checkboxes on a session-scoped form. Otherwise, properties can be given initial values where the field is declared.

If the form is stored in session-scope so that values can be collected over multiple requests (a "wizard"), you must be very careful of which properties, if any, are reset. As mentioned, session-scope checkboxes must be reset to false for any page where this property is set. This is because the client does not submit a checkbox value when it is clear (false). If a session-scoped checkbox is not proactively reset, it can never be set to false.

This method is not the appropriate place to initialize form value for an "update" type page (this should be done in a setup Action). You mainly need to worry about setting checkbox values to false; most of the time you can leave this method unimplemented.


fillIEFromForm

public java.util.List fillIEFromForm(ru.gammalabs.ice.publishing.IE ie,
                                     ru.gammalabs.ice.presentation.web.SessionData sessionData)
                              throws EditIEFormBeanValidationError,
                                     ru.gammalabs.ice.presentation.web.ActionException
Fill the given IE object with values given by the inputs in this formBean Also updates locales list of ie.


fillFormFromIE

public void fillFormFromIE(ru.gammalabs.ice.publishing.IE ie,
                           ru.gammalabs.ice.presentation.web.SessionData sessionData,
                           org.apache.struts.util.MessageResources messageResources,
                           boolean preserveCurrentValues)
                    throws ru.gammalabs.ice.presentation.web.ActionException
Fill the fields of this form with the values from the given ie object Also fills the status list.


isEditingExistingIE

public boolean isEditingExistingIE()
Does this form serve to edit exisiting IE? Checks whether valid id for IE is apecified in form.


isEditingCreatedIE

public boolean isEditingCreatedIE()
Does this form serve to edit newly created IE? Checks whether valid id for IEType is apecified in form.


doesAnyFieldEditorWantFormReload

public boolean doesAnyFieldEditorWantFormReload()
Checks whether at least ine field editor wants the ie edit form to be reloaded.


isSendNotifications

public boolean isSendNotifications()

setSendNotifications

public void setSendNotifications(boolean sendNotifications)