java.lang.Object
- org.silverpeas.core.contribution.content.form.PagesContext

All Implemented Interfaces:

Serializable
```
public class PagesContext
extends Object
implements Serializable
```
The page context where a form is displayed.

See Also:

Serialized Form

Field Summary

Fields
Modifier and Type	Field	Description
`static int`	`ON_UPDATE_IGNORE_EMPTY_VALUES`
`static int`	`ON_UPDATE_REPLACE_EMPTY_VALUES`
`static String`	`OPERATOR_AND`
`static String`	`OPERATOR_OR`

Constructor Summary

Constructors
Constructor	Description
`PagesContext()`
`PagesContext(String formIndex, String language)`
`PagesContext(String formName, String formIndex, String language)`
`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)`
`PagesContext(PagesContext pc)`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`String`	`getComponentId()`
`String`	`getContentLanguage()`
`String`	`getCurrentFieldIndex()`
`static PagesContext`	`getDirectoryContext(String userId, String contributorId, String userLanguage)`
`String`	`getDomainId()`
`String`	`getElementToHideWhenSkipping()`
`String`	`getEncoding()`
`String`	`getFormIndex()`
`String`	`getFormName()`
`String`	`getLanguage()`
`int`	`getLastFieldIndex()`
`int`	`getNbFields()`
`String`	`getNodeId()`
`String`	`getObjectId()`
`boolean`	`getPrintTitle()`
`RenderingContext`	`getRenderingContext()`
`String`	`getSearchOperator(String fieldName, String defaultOperator)`
`String`	`getServerURL()`
`SharingContext`	`getSharingContext()`
`int`	`getUpdatePolicy()`
`String`	`getUserId()`
`void`	`incCurrentFieldIndex(int increment)`
`boolean`	`isBlankFieldsUse()`
`boolean`	`isBorderPrinted()`
`boolean`	`isCreation()`
`boolean`	`isDesignMode()`
`boolean`	`isExtraSearchFieldPeriod()`
`boolean`	`isExtraSearchFieldSpace()`
`boolean`	`isFormSkippable()`
`boolean`	`isIgnoreDefaultValues()`
`boolean`	`isMultiFormInPage()`
`boolean`	`isSharingContext()`
`boolean`	`isShowMandatorySnippet()`
`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`	`setDomainId(String domainId)`
`void`	`setElementToHideWhenSkipping(String elementToHideWhenSkipping)`
`void`	`setEncoding(String encoding)`
`void`	`setExtraSearchFieldPeriod(boolean extraSearchFieldPeriod)`
`void`	`setExtraSearchFieldSpace(boolean extraSearchFieldSpace)`
`void`	`setFormIndex(String formIndex)`
`void`	`setFormName(String formName)`
`void`	`setFormSkippable(boolean formSkippable)`
`void`	`setIgnoreDefaultValues(boolean ignoreDefaultValues)`
`void`	`setLanguage(String language)`
`void`	`setLastFieldIndex(int lastFieldIndex)`
`void`	`setMultiFormInPage(boolean multiFormInPage)`
`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`	`setSearchOperator(String fieldName, String operator)`
`void`	`setSharingContext(SharingContext sharingContext)`
`void`	`setShowMandatorySnippet(boolean showMandatorySnippet)`
`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
- OPERATOR_AND
```
public static final String OPERATOR_AND
```
  See Also:
  
  Constant Field Values
- OPERATOR_OR
```
public static final String OPERATOR_OR
```
  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 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()
```

getDirectoryContext

public static PagesContext getDirectoryContext(String userId,
                                               String contributorId,
                                               String userLanguage)

setSearchOperator

public void setSearchOperator(String fieldName,
                              String operator)

getSearchOperator

public String getSearchOperator(String fieldName,
                                String defaultOperator)

isFormSkippable
```
public boolean isFormSkippable()
```

setFormSkippable

public void setFormSkippable(boolean formSkippable)

getElementToHideWhenSkipping

public String getElementToHideWhenSkipping()

setElementToHideWhenSkipping

public void setElementToHideWhenSkipping(String elementToHideWhenSkipping)

getDomainId
```
public String getDomainId()
```

setDomainId

public void setDomainId(String domainId)

isExtraSearchFieldPeriod

public boolean isExtraSearchFieldPeriod()

setExtraSearchFieldPeriod

public void setExtraSearchFieldPeriod(boolean extraSearchFieldPeriod)

isExtraSearchFieldSpace

public boolean isExtraSearchFieldSpace()

setExtraSearchFieldSpace

public void setExtraSearchFieldSpace(boolean extraSearchFieldSpace)

isMultiFormInPage
```
public boolean isMultiFormInPage()
```

setMultiFormInPage

public void setMultiFormInPage(boolean multiFormInPage)

isShowMandatorySnippet

public boolean isShowMandatorySnippet()

setShowMandatorySnippet

public void setShowMandatorySnippet(boolean showMandatorySnippet)

Class PagesContext

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

ON_UPDATE_REPLACE_EMPTY_VALUES

ON_UPDATE_IGNORE_EMPTY_VALUES

OPERATOR_AND

OPERATOR_OR

Constructor Detail

PagesContext

PagesContext

PagesContext

PagesContext

PagesContext

PagesContext

PagesContext

Method Detail

getRenderingContext

setRenderingContext

getFormName

setFormName

getFormIndex

setFormIndex

getCurrentFieldIndex

getLanguage

setLanguage

getPrintTitle

setPrintTitle

setCurrentFieldIndex

incCurrentFieldIndex

getComponentId

setComponentId

getUserId

setUserId

getObjectId

setObjectId

isVersioningUsed

setVersioningUsed

isBorderPrinted

setBorderPrinted

getContentLanguage

setContentLanguage

getNbFields

setNbFields

getNodeId

setNodeId

getLastFieldIndex

setLastFieldIndex

isBlankFieldsUse

setUseBlankFields

useMandatory

setUseMandatory

getUpdatePolicy

setUpdatePolicy

isIgnoreDefaultValues

setIgnoreDefaultValues

getEncoding

setEncoding

isCreation

setCreation

getServerURL

setRequest

isDesignMode

setDesignMode

getSharingContext

setSharingContext

isSharingContext

getDirectoryContext

setSearchOperator

getSearchOperator

isFormSkippable

setFormSkippable

getElementToHideWhenSkipping

setElementToHideWhenSkipping

getDomainId

setDomainId

isExtraSearchFieldPeriod

setExtraSearchFieldPeriod