com.silverpeas.form
Class PagesContext

java.lang.Object
  com.silverpeas.form.PagesContext

public class PagesContext
extends Object

The page context where a form is displayed.

Field Summary

static int	ON_UPDATE_IGNORE_EMPTY_VALUES
static int	ON_UPDATE_REPLACE_EMPTY_VALUES

Constructor Summary

PagesContext()

PagesContext(PagesContext pc)

PagesContext(String formIndex, String language)

PagesContext(String formIndex, String language, boolean printTitle)

PagesContext(String formName, String formIndex, String language)

PagesContext(String formName, String formIndex, String language, boolean printTitle)

PagesContext(String formName, String formIndex, String language, boolean printTitle, String componentId, String userId)

PagesContext(String formName, String formIndex, String language, boolean printTitle, String componentId, String userId, String nodeId)

PagesContext(String formName, String formIndex, String language, String userId)

Method Summary

String	getComponentId()
String	getContentLanguage()
String	getCurrentFieldIndex()
String	getEncoding()
String	getFormIndex()
String	getFormName()
String	getLanguage()
int	getLastFieldIndex()
int	getNbFields()
String	getNodeId()
String	getObjectId()
boolean	getPrintTitle()
RenderingContext	getRenderingContext()
String	getServerURL()
SharingContext	getSharingContext()
int	getUpdatePolicy()
String	getUserId()
void	incCurrentFieldIndex(int increment)
boolean	isBlankFieldsUse()
boolean	isBorderPrinted()
boolean	isCreation()
boolean	isDesignMode()
boolean	isIgnoreDefaultValues()
boolean	isSharingContext()
boolean	isVersioningUsed()
void	setBorderPrinted(boolean b) Used by Form.
void	setComponentId(String string)
void	setContentLanguage(String contentLanguage)
void	setCreation(boolean creation)
void	setCurrentFieldIndex(String currentFieldIndex)
void	setDesignMode(boolean designMode)
void	setEncoding(String encoding)
void	setFormIndex(String formIndex)
void	setFormName(String formName)
void	setIgnoreDefaultValues(boolean ignoreDefaultValues)
void	setLanguage(String language)
void	setLastFieldIndex(int lastFieldIndex)
void	setNbFields(int nbFields)
void	setNodeId(String nodeId)
void	setObjectId(String string)
void	setPrintTitle(boolean printTitle)
void	setRenderingContext(RenderingContext context)
void	setRequest(javax.servlet.http.HttpServletRequest request)
void	setSharingContext(SharingContext sharingContext)
void	setUpdatePolicy(int updatePolicy)
void	setUseBlankFields(boolean useBlankFields)
void	setUseMandatory(boolean ignoreMandatory)
void	setUserId(String string)
void	setVersioningUsed(boolean b)
boolean	useMandatory()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

ON_UPDATE_REPLACE_EMPTY_VALUES

public static final int ON_UPDATE_REPLACE_EMPTY_VALUES

See Also:

Constant Field Values

ON_UPDATE_IGNORE_EMPTY_VALUES

public static final int ON_UPDATE_IGNORE_EMPTY_VALUES

See Also:

Constant Field Values

Constructor Detail

PagesContext

public PagesContext()

PagesContext

public PagesContext(PagesContext pc)

PagesContext

public PagesContext(String formIndex,
                    String language)

PagesContext

public PagesContext(String formName,
                    String formIndex,
                    String language)

PagesContext

public PagesContext(String formName,
                    String formIndex,
                    String language,
                    String userId)

PagesContext

public PagesContext(String formIndex,
                    String language,
                    boolean printTitle)

PagesContext

public PagesContext(String formName,
                    String formIndex,
                    String language,
                    boolean printTitle)

PagesContext

public PagesContext(String formName,
                    String formIndex,
                    String language,
                    boolean printTitle,
                    String componentId,
                    String userId)

PagesContext

public PagesContext(String formName,
                    String formIndex,
                    String language,
                    boolean printTitle,
                    String componentId,
                    String userId,
                    String nodeId)

Method Detail

getRenderingContext

public RenderingContext getRenderingContext()

setRenderingContext

public final void setRenderingContext(RenderingContext context)

getFormName

public String getFormName()

setFormName

public final void setFormName(String formName)

getFormIndex

public String getFormIndex()

setFormIndex

public final void setFormIndex(String formIndex)

getCurrentFieldIndex

public String getCurrentFieldIndex()

getLanguage

public String getLanguage()

setLanguage

public final void setLanguage(String language)

getPrintTitle

public boolean getPrintTitle()

setPrintTitle

public final void setPrintTitle(boolean printTitle)

setCurrentFieldIndex

public final void setCurrentFieldIndex(String currentFieldIndex)

incCurrentFieldIndex

public final void incCurrentFieldIndex(int increment)

getComponentId

public String getComponentId()

setComponentId

public final void setComponentId(String string)

getUserId

public String getUserId()

setUserId

public final void setUserId(String string)

getObjectId

public String getObjectId()

setObjectId

public final void setObjectId(String string)

isVersioningUsed

public boolean isVersioningUsed()

setVersioningUsed

public final void setVersioningUsed(boolean b)

isBorderPrinted

public boolean isBorderPrinted()

setBorderPrinted

public final void setBorderPrinted(boolean b)

Used by Form. If parameter equals true, encapsulated border (around the form) will be written. Else no border will be displayed. Default value = true.

Parameters:

b -

getContentLanguage

public String getContentLanguage()

setContentLanguage

public final void setContentLanguage(String contentLanguage)

getNbFields

public int getNbFields()

setNbFields

public final void setNbFields(int nbFields)

getNodeId

public String getNodeId()

setNodeId

public final void setNodeId(String nodeId)

getLastFieldIndex

public int getLastFieldIndex()

setLastFieldIndex

public final void setLastFieldIndex(int lastFieldIndex)

isBlankFieldsUse

public boolean isBlankFieldsUse()

setUseBlankFields

public final void setUseBlankFields(boolean useBlankFields)

useMandatory

public boolean useMandatory()

setUseMandatory

public final void setUseMandatory(boolean ignoreMandatory)

getUpdatePolicy

public int getUpdatePolicy()

setUpdatePolicy

public final void setUpdatePolicy(int updatePolicy)

isIgnoreDefaultValues

public boolean isIgnoreDefaultValues()

setIgnoreDefaultValues

public final void setIgnoreDefaultValues(boolean ignoreDefaultValues)

getEncoding

public String getEncoding()

setEncoding

public final void setEncoding(String encoding)

isCreation

public boolean isCreation()

setCreation

public void setCreation(boolean creation)

getServerURL

public String getServerURL()

setRequest

public void setRequest(javax.servlet.http.HttpServletRequest request)

isDesignMode

public boolean isDesignMode()

setDesignMode

public void setDesignMode(boolean designMode)

getSharingContext

public SharingContext getSharingContext()

setSharingContext

public void setSharingContext(SharingContext sharingContext)

isSharingContext

public boolean isSharingContext()