CmsClientSitemapEntry

java.lang.Object
- org.opencms.ade.sitemap.shared.CmsClientSitemapEntry

所有已实现的接口:: com.google.gwt.user.client.rpc.IsSerializable

public class CmsClientSitemapEntry
extends java.lang.Object
implements com.google.gwt.user.client.rpc.IsSerializable

Sitemap entry data.

从以下版本开始:: 8.0.0

嵌套类概要

嵌套类
限定符和类型	类和说明
`static class`	`CmsClientSitemapEntry.EditStatus` An enum for the edit status of the entry.
`static class`	`CmsClientSitemapEntry.EntryType` An enum for the entry type.

字段概要

字段
限定符和类型字段和说明

static java.lang.String HIDDEN_NAVIGATION_ENTRY
NavInfo property value to mark hidden navigation entries.

字段
限定符和类型	字段和说明
`static java.lang.String`	`HIDDEN_NAVIGATION_ENTRY` NavInfo property value to mark hidden navigation entries.

构造器概要

构造器
构造器和说明

CmsClientSitemapEntry()
Constructor.

CmsClientSitemapEntry(CmsClientSitemapEntry clone)
Creates a copy without children of the given entry.

构造器
构造器和说明
`CmsClientSitemapEntry()` Constructor.
`CmsClientSitemapEntry(CmsClientSitemapEntry clone)` Creates a copy without children of the given entry.

方法概要

方法
限定符和类型	方法和说明
`void`	`addSubEntry(CmsClientSitemapEntry entry, I_CmsSitemapController controller)` Adds the given entry to the children.
`java.util.List<java.lang.String>`	`getAliases()` Returns the aliases.
`boolean`	`getChildrenLoadedInitially()` Returns true if this item's children have been loaded initially.
`java.lang.String`	`getDateExpired()` Returns the expiration date.
`java.lang.String`	`getDateReleased()` Returns the release date.
`CmsUUID`	`getDefaultFileId()` Gets the default file id.
`java.util.Map<java.lang.String,CmsClientProperty>`	`getDefaultFileProperties()` Returns the properties for the default file.
`java.lang.String`	`getDefaultFileType()` Returns the default file resource type name.
`java.lang.String`	`getDetailpageTypeName()` Returns the detail resource type name.
`CmsClientSitemapEntry.EntryType`	`getEntryType()` Returns the entry type.
`java.lang.String`	`getExportName()` Returns the cached export name for this entry.
`CmsUUID`	`getId()` Returns the id.
`CmsClientLock`	`getLock()` Returns the lock of the entry resource.
`java.lang.String`	`getName()` Returns the name.
`java.lang.String`	`getNoEditReason()` Returns the no edit reason.
`java.util.Map<java.lang.String,CmsClientProperty>`	`getOwnProperties()` Returns the properties for the entry itself.
`int`	`getPosition()` Returns the position.
`java.lang.String`	`getPropertyValue(java.lang.String propertyName)` Returns the property value or null if not set.
`java.lang.String`	`getRedirectTarget()` Returns the redirect target.
`CmsResourceState`	`getResourceState()` Returns the resource state.
`java.lang.String`	`getResourceTypeName()` Returns the resource type name.
`java.lang.String`	`getSitePath()` Returns the sitemap path.
`java.util.List<CmsClientSitemapEntry>`	`getSubEntries()` Returns the children.
`java.lang.String`	`getTitle()` Returns the title.
`java.lang.String`	`getVfsPath()` Returns the vfs path.
`boolean`	`hasBlockingLockedChildren()` Returns if this entry has blocking locked children.
`boolean`	`hasForeignFolderLock()` Returns if the entry folder is locked by another user.
`void`	`initialize(I_CmsSitemapController controller)` Initializes this sitemap entry.
`void`	`initializeAll(I_CmsSitemapController controller)` Initializes this sitemap entry and its descendants.
`void`	`insertSubEntry(CmsClientSitemapEntry entry, int position, I_CmsSitemapController controller)` Inserts the given entry at the given position.
`boolean`	`isEditable()` Returns if the current lock state allows editing.
`boolean`	`isFolderDefaultPage()` Returns if the entry is the folder default page.
`boolean`	`isFolderType()` Returns if this entry is of type folder.
`boolean`	`isHiddenNavigationEntry()` Returns if this is a hidden navigation entry.
`boolean`	`isInNavigation()` Returns if the entry is visible in navigation.
`boolean`	`isLeafType()` Returns if this entry is of type leaf.
`boolean`	`isNavigationLevelType()` Returns if this entry is of type folder.
`boolean`	`isNew()` Returns the "new" flag of the sitemap entry.
`boolean`	`isResleasedAndNotExpired()` Returns if the resource is released and not expired.
`boolean`	`isRoot()` Returns true if this entry is the root entry of the sitemap.
`boolean`	`isSubSitemapType()` Returns if this entry is of type sub-sitemap.
`void`	`normalizeProperties()` Removes empty properties.
`CmsClientSitemapEntry`	`removeSubEntry(CmsUUID entryId)` Removes the child at the given position.
`CmsClientSitemapEntry`	`removeSubEntry(int position)` Removes the child at the given position.
`void`	`setAliases(java.util.List<java.lang.String> aliases)` Sets the aliases.
`void`	`setBlockingLockedChildren(boolean hasBlockingLockedChildren)` Sets if the entry resource has blocking locked children that can not be locked by the current user.
`void`	`setChildrenLoadedInitially(boolean childrenLoaded)` Sets the 'children loaded initially' flag.
`void`	`setDateExpired(java.lang.String dateExpired)` Sets the expiration date.
`void`	`setDateReleased(java.lang.String dateReleased)` Sets the release date.
`void`	`setDefaultFileId(CmsUUID defaultFileId)` Sets the default file id.
`void`	`setDefaultFileProperties(java.util.Map<java.lang.String,CmsClientProperty> properties)` Sets the properties for the default file.
`void`	`setDefaultFileType(java.lang.String defaultFileType)` Sets the default file resource type name.
`void`	`setDetailpageTypeName(java.lang.String detailpageTypeName)` Sets the detail resource type name.
`void`	`setEntryType(CmsClientSitemapEntry.EntryType entryType)` Sets the entry type.
`void`	`setExportName(java.lang.String exportName)` Sets the export name for this entry.
`void`	`setFolderDefaultPage(boolean isFolderDefaultPage)` Sets if the entry is the folder default page.
`void`	`setHasForeignFolderLock(boolean hasForeignFolderLock)` Sets if the entry folder is locked by another user.
`void`	`setId(CmsUUID id)` Sets the id.
`void`	`setInNavigation(boolean inNavigation)` Sets the entry visibility in navigation.
`void`	`setLock(CmsClientLock lock)` Sets the lock of the entry resource.
`void`	`setName(java.lang.String name)` Sets the name.
`void`	`setNew(boolean isNew)` Sets the "new" flag of the client sitemap entry.
`void`	`setNoEditReason(java.lang.String noEditReason)` Sets the no edit reason.
`void`	`setOwnProperties(java.util.Map<java.lang.String,CmsClientProperty> properties)` Sets the properties for the entry itself.
`void`	`setPosition(int position)` Sets the position.
`void`	`setRedirectTarget(java.lang.String redirectTarget)` Sets the redirect target.
`void`	`setResleasedAndNotExpired(boolean isResleasedAndNotExpired)` Sets the resource is released and not expired flag.
`void`	`setResourceState(CmsResourceState resourceState)` Sets the resource state.
`void`	`setResourceTypeName(java.lang.String typeName)` Sets the resource type name.
`void`	`setSitePath(java.lang.String sitepath)` Sets the site path.
`void`	`setSubEntries(java.util.List<CmsClientSitemapEntry> children, I_CmsSitemapController controller)` Sets the children.
`void`	`setVfsPath(java.lang.String path)` Sets the VFS path.
`java.lang.String`	`toString()` To string.
`void`	`update(CmsClientSitemapEntry source)` Updates all entry properties apart from it's position-info and sub-entries.
`void`	`updateSitePath(java.lang.String sitepath, I_CmsSitemapController controller)` Updates the entry's site path and the name accordingly.

从类继承的方法 java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- 字段详细资料
  - HIDDEN_NAVIGATION_ENTRY
```
public static final java.lang.String HIDDEN_NAVIGATION_ENTRY
```
    NavInfo property value to mark hidden navigation entries.
    
    另请参阅:
    常量字段值
- 构造器详细资料
  - CmsClientSitemapEntry
```
public CmsClientSitemapEntry()
```
    Constructor.
  - CmsClientSitemapEntry
```
public CmsClientSitemapEntry(CmsClientSitemapEntry clone)
```
    Creates a copy without children of the given entry.
    
    参数:
    clone - the entry to clone
- 方法详细资料
  - addSubEntry
```
public void addSubEntry(CmsClientSitemapEntry entry,
               I_CmsSitemapController controller)
```
    Adds the given entry to the children.
    
    参数:
    entry - the entry to add
    controller - a sitemap controller instance
  - getAliases
```
public java.util.List<java.lang.String> getAliases()
```
    Returns the aliases.
    
    返回:
    the aliases
  - getChildrenLoadedInitially
```
public boolean getChildrenLoadedInitially()
```
    Returns true if this item's children have been loaded initially.
    
    返回:
    true if this item's children have been loaded initially
  - getDateExpired
```
public java.lang.String getDateExpired()
```
    Returns the expiration date.
    
    返回:
    the expiration date
  - getDateReleased
```
public java.lang.String getDateReleased()
```
    Returns the release date.
    
    返回:
    the release date
  - getDefaultFileId
```
public CmsUUID getDefaultFileId()
```
    Gets the default file id.
    
    返回:
    the default file id, or null if there is no detail page
  - getDefaultFileProperties
```
public java.util.Map<java.lang.String,CmsClientProperty> getDefaultFileProperties()
```
    Returns the properties for the default file.
    
    返回:
    the properties for the default file
  - getDefaultFileType
```
public java.lang.String getDefaultFileType()
```
    Returns the default file resource type name.
    
    返回:
    the default file resource type name
  - getDetailpageTypeName
```
public java.lang.String getDetailpageTypeName()
```
    Returns the detail resource type name.
    
    返回:
    the detail resource type name
  - getEntryType
```
public CmsClientSitemapEntry.EntryType getEntryType()
```
    Returns the entry type.
    
    返回:
    the entry type
  - getExportName
```
public java.lang.String getExportName()
```
    Returns the cached export name for this entry.
    
    返回:
    the cached export name for this entry
  - getId
```
public CmsUUID getId()
```
    Returns the id.
    
    返回:
    the id
  - getLock
```
public CmsClientLock getLock()
```
    Returns the lock of the entry resource.
    
    返回:
    the lock of the entry resource
  - getName
```
public java.lang.String getName()
```
    Returns the name.
    
    返回:
    the name
  - getNoEditReason
```
public java.lang.String getNoEditReason()
```
    Returns the no edit reason.
    
    返回:
    the no edit reason
  - getOwnProperties
```
public java.util.Map<java.lang.String,CmsClientProperty> getOwnProperties()
```
    Returns the properties for the entry itself.
    
    返回:
    the properties for the entry itself
  - getPosition
```
public int getPosition()
```
    Returns the position.
    
    返回:
    the position
  - getPropertyValue
```
public java.lang.String getPropertyValue(java.lang.String propertyName)
```
    Returns the property value or null if not set.
    
    参数:
    propertyName - the property name
    
    返回:
    the property value
  - getRedirectTarget
```
public java.lang.String getRedirectTarget()
```
    Returns the redirect target.
    
    返回:
    the redirect target
  - getResourceState
```
public CmsResourceState getResourceState()
```
    Returns the resource state.
    
    返回:
    the resource state
  - getResourceTypeName
```
public java.lang.String getResourceTypeName()
```
    Returns the resource type name.
    
    返回:
    the resource type name
  - getSitePath
```
public java.lang.String getSitePath()
```
    Returns the sitemap path.
    
    返回:
    the sitemap path
  - getSubEntries
```
public java.util.List<CmsClientSitemapEntry> getSubEntries()
```
    Returns the children.
    
    返回:
    the children
  - getTitle
```
public java.lang.String getTitle()
```
    Returns the title.
    
    返回:
    the title
  - getVfsPath
```
public java.lang.String getVfsPath()
```
    Returns the vfs path.
    
    返回:
    the vfs path
  - hasBlockingLockedChildren
```
public boolean hasBlockingLockedChildren()
```
    Returns if this entry has blocking locked children.
    
    返回:
    true if this entry has blocking locked children
  - hasForeignFolderLock
```
public boolean hasForeignFolderLock()
```
    Returns if the entry folder is locked by another user.
    
    返回:
    true if the entry folder is locked by another user
  - initialize
```
public void initialize(I_CmsSitemapController controller)
```
    Initializes this sitemap entry.
    
    参数:
    controller - a sitemap controller instance
  - initializeAll
```
public void initializeAll(I_CmsSitemapController controller)
```
    Initializes this sitemap entry and its descendants.
    
    参数:
    controller - the controller instance with which to initialize the entries
  - insertSubEntry
```
public void insertSubEntry(CmsClientSitemapEntry entry,
                  int position,
                  I_CmsSitemapController controller)
```
    Inserts the given entry at the given position.
    
    参数:
    entry - the entry to insert
    position - the position
    controller - a sitemap controller instance
  - isEditable
```
public boolean isEditable()
```
    Returns if the current lock state allows editing.
    
    返回:
    true if the resource is editable
  - isFolderDefaultPage
```
public boolean isFolderDefaultPage()
```
    Returns if the entry is the folder default page.
    
    返回:
    if the entry is the folder default page
  - isFolderType
```
public boolean isFolderType()
```
    Returns if this entry is of type folder.
    
    返回:
    true if this entry is of type folder
  - isHiddenNavigationEntry
```
public boolean isHiddenNavigationEntry()
```
    Returns if this is a hidden navigation entry.
    
    返回:
    true if this is a hidden navigation entry
  - isInNavigation
```
public boolean isInNavigation()
```
    Returns if the entry is visible in navigation.
    
    返回:
    true if the entry is visible in navigation
  - isLeafType
```
public boolean isLeafType()
```
    Returns if this entry is of type leaf.
    
    返回:
    true if this entry is of type leaf
  - isNavigationLevelType
```
public boolean isNavigationLevelType()
```
    Returns if this entry is of type folder.
    
    返回:
    true if this entry is of type folder
  - isNew
```
public boolean isNew()
```
    Returns the "new" flag of the sitemap entry.
    
    返回:
    the "new" flag
  - isResleasedAndNotExpired
```
public boolean isResleasedAndNotExpired()
```
    Returns if the resource is released and not expired.
    
    返回:
    true if the resource is released and not expired
  - isRoot
```
public boolean isRoot()
```
    Returns true if this entry is the root entry of the sitemap.
    
    返回:
    true if this entry is the root entry of the sitemap
  - isSubSitemapType
```
public boolean isSubSitemapType()
```
    Returns if this entry is of type sub-sitemap.
    
    返回:
    true if this entry is of type sub-sitemap
  - normalizeProperties
```
public void normalizeProperties()
```
    Removes empty properties.
  - removeSubEntry
```
public CmsClientSitemapEntry removeSubEntry(CmsUUID entryId)
```
    Removes the child at the given position.
    
    参数:
    entryId - the id of the child to remove
    
    返回:
    the removed child
  - removeSubEntry
```
public CmsClientSitemapEntry removeSubEntry(int position)
```
    Removes the child at the given position.
    
    参数:
    position - the index of the child to remove
    
    返回:
    the removed child
  - setAliases
```
public void setAliases(java.util.List<java.lang.String> aliases)
```
    Sets the aliases.
    
    参数:
    aliases - the aliases to set
  - setBlockingLockedChildren
```
public void setBlockingLockedChildren(boolean hasBlockingLockedChildren)
```
    Sets if the entry resource has blocking locked children that can not be locked by the current user.
    
    参数:
    hasBlockingLockedChildren - true if the entry resource has blocking locked children
  - setChildrenLoadedInitially
```
public void setChildrenLoadedInitially(boolean childrenLoaded)
```
    Sets the 'children loaded initially' flag.
    
    参数:
    childrenLoaded - true if children are loaded initially
  - setDateExpired
```
public void setDateExpired(java.lang.String dateExpired)
```
    Sets the expiration date.
    
    参数:
    dateExpired - the expiration date to set
  - setDateReleased
```
public void setDateReleased(java.lang.String dateReleased)
```
    Sets the release date.
    
    参数:
    dateReleased - the release date to set
  - setDefaultFileId
```
public void setDefaultFileId(CmsUUID defaultFileId)
```
    Sets the default file id.
    
    参数:
    defaultFileId - the new default file id
  - setDefaultFileProperties
```
public void setDefaultFileProperties(java.util.Map<java.lang.String,CmsClientProperty> properties)
```
    Sets the properties for the default file.
    
    参数:
    properties - the properties for the default file
  - setDefaultFileType
```
public void setDefaultFileType(java.lang.String defaultFileType)
```
    Sets the default file resource type name.
    
    参数:
    defaultFileType - the default file resource type name to set
  - setDetailpageTypeName
```
public void setDetailpageTypeName(java.lang.String detailpageTypeName)
```
    Sets the detail resource type name.
    
    参数:
    detailpageTypeName - the detail resource type name
  - setEntryType
```
public void setEntryType(CmsClientSitemapEntry.EntryType entryType)
```
    Sets the entry type.
    
    参数:
    entryType - the entry type to set
  - setExportName
```
public void setExportName(java.lang.String exportName)
```
    Sets the export name for this entry.
    
    参数:
    exportName - the export name for this entry
  - setFolderDefaultPage
```
public void setFolderDefaultPage(boolean isFolderDefaultPage)
```
    Sets if the entry is the folder default page.
    
    参数:
    isFolderDefaultPage - the isFolderDefaultPage to set
  - setHasForeignFolderLock
```
public void setHasForeignFolderLock(boolean hasForeignFolderLock)
```
    Sets if the entry folder is locked by another user.
    
    参数:
    hasForeignFolderLock - set true if the entry folder is locked by another user
  - setId
```
public void setId(CmsUUID id)
```
    Sets the id.
    
    参数:
    id - the id to set
  - setInNavigation
```
public void setInNavigation(boolean inNavigation)
```
    Sets the entry visibility in navigation.
    
    参数:
    inNavigation - set true for entries visible in navigation
  - setLock
```
public void setLock(CmsClientLock lock)
```
    Sets the lock of the entry resource.
    
    参数:
    lock - the lock of the entry resource to set
  - setName
```
public void setName(java.lang.String name)
```
    Sets the name.
    
    参数:
    name - the name to set
  - setNew
```
public void setNew(boolean isNew)
```
    Sets the "new" flag of the client sitemap entry.
    
    参数:
    isNew - the new new
  - setNoEditReason
```
public void setNoEditReason(java.lang.String noEditReason)
```
    Sets the no edit reason.
    
    参数:
    noEditReason - the no edit reason to set
  - setOwnProperties
```
public void setOwnProperties(java.util.Map<java.lang.String,CmsClientProperty> properties)
```
    Sets the properties for the entry itself.
    
    参数:
    properties - the properties for the entry itself
  - setPosition
```
public void setPosition(int position)
```
    Sets the position.
    
    参数:
    position - the position to set
  - setRedirectTarget
```
public void setRedirectTarget(java.lang.String redirectTarget)
```
    Sets the redirect target.
    
    参数:
    redirectTarget - the redirect target to set
  - setResleasedAndNotExpired
```
public void setResleasedAndNotExpired(boolean isResleasedAndNotExpired)
```
    Sets the resource is released and not expired flag.
    
    参数:
    isResleasedAndNotExpired - the resource is released and not expired flag
  - setResourceState
```
public void setResourceState(CmsResourceState resourceState)
```
    Sets the resource state.
    
    参数:
    resourceState - the resource state to set
  - setResourceTypeName
```
public void setResourceTypeName(java.lang.String typeName)
```
    Sets the resource type name.
    
    参数:
    typeName - the resource type name
  - setSitePath
```
public void setSitePath(java.lang.String sitepath)
```
    Sets the site path.
    
    参数:
    sitepath - the site path to set
  - setSubEntries
```
public void setSubEntries(java.util.List<CmsClientSitemapEntry> children,
                 I_CmsSitemapController controller)
```
    Sets the children.
    
    参数:
    children - the children to set
    controller - a sitemap controller instance
  - setVfsPath
```
public void setVfsPath(java.lang.String path)
```
    Sets the VFS path.
    
    参数:
    path - the path to set
  - toString
```
public java.lang.String toString()
```
    To string.
    
    覆盖:
    
    toString 在类中 java.lang.Object
    
    返回:
    the string
    另请参阅:
    Object.toString()
  - update
```
public void update(CmsClientSitemapEntry source)
```
    Updates all entry properties apart from it's position-info and sub-entries.
    
    参数:
    source - the source entry to update from
  - updateSitePath
```
public void updateSitePath(java.lang.String sitepath,
                  I_CmsSitemapController controller)
```
    Updates the entry's site path and the name accordingly.
    
    参数:
    sitepath - the new site path to set
    controller - a sitemap controller instance

类 CmsClientSitemapEntry

嵌套类概要

字段概要

构造器概要

方法概要

从类继承的方法 java.lang.Object

字段详细资料

HIDDEN_NAVIGATION_ENTRY

构造器详细资料

CmsClientSitemapEntry

CmsClientSitemapEntry

方法详细资料

addSubEntry

getAliases

getChildrenLoadedInitially

getDateExpired

getDateReleased

getDefaultFileId

getDefaultFileProperties

getDefaultFileType

getDetailpageTypeName

getEntryType

getExportName

getId

getLock

getName

getNoEditReason

getOwnProperties

getPosition

getPropertyValue

getRedirectTarget

getResourceState

getResourceTypeName

getSitePath

getSubEntries

getTitle

getVfsPath

hasBlockingLockedChildren

hasForeignFolderLock

initialize

initializeAll

insertSubEntry

isEditable

isFolderDefaultPage

isFolderType

isHiddenNavigationEntry

isInNavigation

isLeafType

isNavigationLevelType

isNew

isResleasedAndNotExpired

isRoot

isSubSitemapType

normalizeProperties

removeSubEntry

removeSubEntry

setAliases

setBlockingLockedChildren

setChildrenLoadedInitially

setDateExpired

setDateReleased

setDefaultFileId

setDefaultFileProperties

setDefaultFileType

setDetailpageTypeName

setEntryType

setExportName

setFolderDefaultPage

setHasForeignFolderLock

setId

setInNavigation

setLock

setName

setNew

setNoEditReason

setOwnProperties

setPosition

setRedirectTarget

setResleasedAndNotExpired

setResourceState