ClientConfigElement (Alfresco Web Client API)

java.lang.Object
- org.springframework.extensions.config.element.ConfigElementAdapter
- - org.alfresco.web.config.ClientConfigElement

All Implemented Interfaces:

java.io.Serializable, org.springframework.extensions.config.ConfigElement
```
public class ClientConfigElement
extends org.springframework.extensions.config.element.ConfigElementAdapter
```
Custom config element that represents config values for the client

See Also:
Serialized Form

Field Summary

Fields
Modifier and Type Field and Description

static java.lang.String BREADCRUMB_LOCATION

static java.lang.String BREADCRUMB_PATH

static java.lang.String CONFIG_ELEMENT_ID
- Fields inherited from class org.springframework.extensions.config.element.ConfigElementAdapter
  attributes, children, name, value

Fields
Modifier and Type	Field and Description
`static java.lang.String`	`BREADCRUMB_LOCATION`
`static java.lang.String`	`BREADCRUMB_PATH`
`static java.lang.String`	`CONFIG_ELEMENT_ID`

Constructor Summary

Constructors
Constructor and Description

ClientConfigElement()
Default Constructor

ClientConfigElement(java.lang.String name)
Constructor

Constructors
Constructor and Description
`ClientConfigElement()` Default Constructor
`ClientConfigElement(java.lang.String name)` Constructor

Method Summary

Methods
Modifier and Type	Method and Description
`org.springframework.extensions.config.ConfigElement`	`combine(org.springframework.extensions.config.ConfigElement configElement)`
`boolean`	`getAllowGuestConfig()`
`boolean`	`getAllowUserConfig()`
`boolean`	`getAllowUserScriptExecute()`
`java.lang.String`	`getBreadcrumbMode()` Get the breadcrumb mode
`boolean`	`getCheckContextAgainstPath()`
`java.lang.String`	`getCifsURLSuffix()` Get the CIFs URL suffix
`java.lang.String`	`getDefaultHomeSpacePath()`
`java.lang.String`	`getEditLinkType()`
`java.lang.String`	`getErrorPage()`
`boolean`	`getForceAndTerms()`
`java.lang.String`	`getFromEmailAddress()`
`java.lang.String`	`getHelpUrl()`
`java.lang.String`	`getHomeSpacePermission()`
`java.lang.String`	`getInitialLocation()`
`int`	`getInviteUsersMaxResults()` If positive, this will limit the size of the result set from the invite users wizard.
`java.lang.String`	`getLoginPage()`
`int`	`getMaxPasswordLength()`
`int`	`getMinGroupNameLength()`
`int`	`getMinPasswordLength()`
`int`	`getMinUsernameLength()`
`int`	`getPickerSearchMinimum()`
`int`	`getRecentSpacesItems()`
`int`	`getSearchMaxResults()` If positive, this will limit the size of the result set from the search.
`int`	`getSearchMinimum()`
`int`	`getSelectorsSearchMaxResults()` If positive, this will limit the size of the result set from the search used in selector components.
`java.util.List`	`getSimpleSearchAdditionalAttributes()`
`int`	`getTasksCompletedMaxResults()` If positive, this will limit the size of the result set of the completed tasks.
`java.lang.String`	`getWCMDomain()`
`java.lang.String`	`getWCMPort()`
`boolean`	`isClipboardStatusVisible()`
`boolean`	`isLanguageSelect()`
`boolean`	`isNodeSummaryEnabled()`
`boolean`	`isPasteAllAndClearEnabled()`
`boolean`	`isShelfVisible()`
`boolean`	`isUserGroupAdmin()`
`boolean`	`isZeroByteFileUploads()`
`void`	`setMaxPasswordLength(int maxPasswordLength)`

Methods inherited from class org.springframework.extensions.config.element.ConfigElementAdapter
getAttribute, getAttributeCount, getAttributes, getChild, getChildCount, getChildren, getChildren, getChildrenMap, getChildValue, getName, getValue, hasAttribute, hasChildren, setValue, toString

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Field Detail
  - CONFIG_ELEMENT_ID
```
public static final java.lang.String CONFIG_ELEMENT_ID
```
    See Also:
    Constant Field Values
  - BREADCRUMB_PATH
```
public static final java.lang.String BREADCRUMB_PATH
```
    See Also:
    Constant Field Values
  - BREADCRUMB_LOCATION
```
public static final java.lang.String BREADCRUMB_LOCATION
```
    See Also:
    Constant Field Values
- Constructor Detail
  - ClientConfigElement
```
public ClientConfigElement()
```
    Default Constructor
  - ClientConfigElement
```
public ClientConfigElement(java.lang.String name)
```
    Constructor
    
    Parameters:
    name - Name of the element this config element represents
- Method Detail
  - combine
```
public org.springframework.extensions.config.ConfigElement combine(org.springframework.extensions.config.ConfigElement configElement)
```
    Specified by:
    
    combine in interface org.springframework.extensions.config.ConfigElement
    
    Specified by:
    
    combine in class org.springframework.extensions.config.element.ConfigElementAdapter
    
    See Also:
    org.springframework.extensions.config.element.ConfigElementAdapter#combine(org.alfresco.config.ConfigElement)
  - getRecentSpacesItems
```
public int getRecentSpacesItems()
```
    Returns:
    Returns the recentSpacesItems.
  - isShelfVisible
```
public boolean isShelfVisible()
```
    Returns:
    Returns if the shelf component is visible by default.
  - isClipboardStatusVisible
```
public boolean isClipboardStatusVisible()
```
    Returns:
    Returns if the clipboard status messages are visible by default.
  - isPasteAllAndClearEnabled
```
public boolean isPasteAllAndClearEnabled()
```
    Returns:
    Returns if the clipboard paste all action should clear the clipboard.
  - getErrorPage
```
public java.lang.String getErrorPage()
```
    Returns:
    The error page the application should use
  - getLoginPage
```
public java.lang.String getLoginPage()
```
    Returns:
    Returns the login Page.
  - getHelpUrl
```
public java.lang.String getHelpUrl()
```
    Returns:
    Returns the help Url.
  - getFromEmailAddress
```
public java.lang.String getFromEmailAddress()
```
    Returns:
    Returns the from email address, if one has not been set [email protected] will be returned
  - getEditLinkType
```
public java.lang.String getEditLinkType()
```
    Returns:
    Returns the edit link type.
  - getSearchMinimum
```
public int getSearchMinimum()
```
    Returns:
    Returns the search minimum number of characters.
  - getForceAndTerms
```
public boolean getForceAndTerms()
```
    Returns:
    If true enables AND text terms for simple/advanced search by default.
  - getSearchMaxResults
```
public int getSearchMaxResults()
```
    If positive, this will limit the size of the result set from the search.
    
    Returns:
    The maximum number of results to show
  - getSelectorsSearchMaxResults
```
public int getSelectorsSearchMaxResults()
```
    If positive, this will limit the size of the result set from the search used in selector components.
    
    Returns:
    The maximum number of results to display
  - getInviteUsersMaxResults
```
public int getInviteUsersMaxResults()
```
    If positive, this will limit the size of the result set from the invite users wizard.
    
    Returns:
    The maximum number of results to display
  - getTasksCompletedMaxResults
```
public int getTasksCompletedMaxResults()
```
    If positive, this will limit the size of the result set of the completed tasks.
    
    Returns:
    The maximum number of completed tasks to display
  - getHomeSpacePermission
```
public java.lang.String getHomeSpacePermission()
```
    Returns:
    Returns the default Home Space permissions.
  - getDefaultHomeSpacePath
```
public java.lang.String getDefaultHomeSpacePath()
```
    Returns:
    Returns the default Home Space path.
  - isNodeSummaryEnabled
```
public boolean isNodeSummaryEnabled()
```
    Returns:
    Returns whether AJAX support is enabled in the client
  - getInitialLocation
```
public java.lang.String getInitialLocation()
```
    Returns:
    Returns the default initial location for the user.
  - getWCMDomain
```
public java.lang.String getWCMDomain()
```
    Returns:
    Returns the WCM Domain obtained from the Virtualisation Server registry.
  - getWCMPort
```
public java.lang.String getWCMPort()
```
    Returns:
    Returns the WCM Port obtained from the Virtualisation Server registry.
  - getAllowGuestConfig
```
public boolean getAllowGuestConfig()
```
  - getSimpleSearchAdditionalAttributes
```
public java.util.List getSimpleSearchAdditionalAttributes()
```
    Returns:
    Returns the additional attributes to search on a simple search
  - getMinUsernameLength
```
public int getMinUsernameLength()
```
    Returns:
    Returns the minimum length for a username.
  - getMinPasswordLength
```
public int getMinPasswordLength()
```
    Returns:
    Returns the minimum length for a password.
  - getMaxPasswordLength
```
public int getMaxPasswordLength()
```
    Returns:
    Returns the maximum length for a password.
  - setMaxPasswordLength
```
public void setMaxPasswordLength(int maxPasswordLength)
```
    Parameters:
    maxPasswordLength - The maximum length of a password
  - getMinGroupNameLength
```
public int getMinGroupNameLength()
```
    Returns:
    Returns the minimum length for a group name.
  - getBreadcrumbMode
```
public final java.lang.String getBreadcrumbMode()
```
    Get the breadcrumb mode
    
    Returns:
    String
  - getCifsURLSuffix
```
public final java.lang.String getCifsURLSuffix()
```
    Get the CIFs URL suffix
    
    Returns:
    String
  - isLanguageSelect
```
public final boolean isLanguageSelect()
```
    Returns:
    the language select flag - true to display language selection, false to get the language from the client browser locale instead
  - isZeroByteFileUploads
```
public boolean isZeroByteFileUploads()
```
    Returns:
    true if zero byte file uploads are allowed, false otherwise
  - isUserGroupAdmin
```
public boolean isUserGroupAdmin()
```
    Returns:
    true if allowing User Group administration by an admin user
  - getAllowUserConfig
```
public boolean getAllowUserConfig()
```
    Returns:
    true to allow users to modify their personal settings in the User Console screen
  - getPickerSearchMinimum
```
public int getPickerSearchMinimum()
```
    Returns:
    Returns the minimum number of characters for a picker search.
  - getCheckContextAgainstPath
```
public boolean getCheckContextAgainstPath()
```
    Returns:
    true if the context path should be checked against the path in the current URL
  - getAllowUserScriptExecute
```
public boolean getAllowUserScriptExecute()
```
    Returns:
    true if any user can execute JavaScript via the command servlet

Class ClientConfigElement

Field Summary

Fields inherited from class org.springframework.extensions.config.element.ConfigElementAdapter

Constructor Summary

Method Summary

Methods inherited from class org.springframework.extensions.config.element.ConfigElementAdapter

Methods inherited from class java.lang.Object

Field Detail

CONFIG_ELEMENT_ID

BREADCRUMB_PATH

BREADCRUMB_LOCATION

Constructor Detail

ClientConfigElement

ClientConfigElement

Method Detail

combine

getRecentSpacesItems

isShelfVisible

isClipboardStatusVisible

isPasteAllAndClearEnabled

getErrorPage

getLoginPage

getHelpUrl

getFromEmailAddress

getEditLinkType

getSearchMinimum

getForceAndTerms

getSearchMaxResults

getSelectorsSearchMaxResults

getInviteUsersMaxResults

getTasksCompletedMaxResults

getHomeSpacePermission

getDefaultHomeSpacePath

isNodeSummaryEnabled

getInitialLocation

getWCMDomain

getWCMPort

getAllowGuestConfig

getSimpleSearchAdditionalAttributes

getMinUsernameLength

getMinPasswordLength

getMaxPasswordLength

setMaxPasswordLength

getMinGroupNameLength

getBreadcrumbMode

getCifsURLSuffix

isLanguageSelect

isZeroByteFileUploads

isUserGroupAdmin

getAllowUserConfig

getPickerSearchMinimum

getCheckContextAgainstPath

getAllowUserScriptExecute