public class CmsClientSitemapEntry extends java.lang.Object implements com.google.gwt.user.client.rpc.IsSerializable
| Modifier and Type | Class and Description |
|---|---|
static class |
CmsClientSitemapEntry.EditStatus
An enum for the edit status of the entry.
|
static class |
CmsClientSitemapEntry.EntryType
An enum for the entry type.
|
| Modifier and Type | Field and Description |
|---|---|
static java.lang.String |
HIDDEN_NAVIGATION_ENTRY
NavInfo property value to mark hidden navigation entries.
|
| Constructor and Description |
|---|
CmsClientSitemapEntry()
Constructor.
|
CmsClientSitemapEntry(CmsClientSitemapEntry clone)
Creates a copy without children of the given entry.
|
| Modifier and Type | Method and Description |
|---|---|
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 |
getNavModeIcon()
Returns the nav mode icon style classes.
|
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.
|
int |
getResourceTypeId()
Returns the resource type id.
|
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 |
getVfsModeIcon()
Returns the vfs mode icon style classes.
|
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 |
isDefaultFileReleased()
Returns the default file is released and not expired flag.
|
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 |
setDefaultFileReleased(boolean defaultFileReleased)
Sets the default file is released and not expired flag.
|
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 |
setNavModeIcon(java.lang.String iconClasses)
Sets the nav mode icon style classes.
|
void |
setNew(boolean isNew)
Sets the "new" flag of the client sitemap entry.
|
void |
setOwnProperties(java.util.Map<java.lang.String,CmsClientProperty> properties)
Sets the properties for the entry itself.
|
void |
setPermissionInfo(CmsPermissionInfo permissionInfo)
Sets the permission info.
|
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 |
setResourceTypeId(int resourceTypeId)
Sets the resource type id.
|
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 |
setVfsModeIcon(java.lang.String iconClasses)
Sets the vfs mode icon style classes.
|
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.
|
public static final java.lang.String HIDDEN_NAVIGATION_ENTRY
public CmsClientSitemapEntry()
public CmsClientSitemapEntry(CmsClientSitemapEntry clone)
clone - the entry to clonepublic void addSubEntry(CmsClientSitemapEntry entry, I_CmsSitemapController controller)
entry - the entry to addcontroller - a sitemap controller instancepublic java.util.List<java.lang.String> getAliases()
public boolean getChildrenLoadedInitially()
public java.lang.String getDateExpired()
public java.lang.String getDateReleased()
public CmsUUID getDefaultFileId()
public java.util.Map<java.lang.String,CmsClientProperty> getDefaultFileProperties()
public java.lang.String getDefaultFileType()
public java.lang.String getDetailpageTypeName()
public CmsClientSitemapEntry.EntryType getEntryType()
public java.lang.String getExportName()
public CmsClientLock getLock()
public java.lang.String getName()
public java.lang.String getNavModeIcon()
public java.lang.String getNoEditReason()
public java.util.Map<java.lang.String,CmsClientProperty> getOwnProperties()
public int getPosition()
public java.lang.String getPropertyValue(java.lang.String propertyName)
propertyName - the property namepublic java.lang.String getRedirectTarget()
public CmsResourceState getResourceState()
public int getResourceTypeId()
public java.lang.String getResourceTypeName()
public java.lang.String getSitePath()
public java.util.List<CmsClientSitemapEntry> getSubEntries()
public java.lang.String getTitle()
public java.lang.String getVfsModeIcon()
public java.lang.String getVfsPath()
public boolean hasBlockingLockedChildren()
true if this entry has blocking locked childrenpublic boolean hasForeignFolderLock()
true if the entry folder is locked by another userpublic void initialize(I_CmsSitemapController controller)
controller - a sitemap controller instancepublic void initializeAll(I_CmsSitemapController controller)
controller - the controller instance with which to initialize the entriespublic void insertSubEntry(CmsClientSitemapEntry entry, int position, I_CmsSitemapController controller)
entry - the entry to insertposition - the positioncontroller - a sitemap controller instancepublic boolean isDefaultFileReleased()
public boolean isEditable()
true if the resource is editablepublic boolean isFolderDefaultPage()
public boolean isFolderType()
true if this entry is of type folderpublic boolean isHiddenNavigationEntry()
true if this is a hidden navigation entrypublic boolean isInNavigation()
true if the entry is visible in navigationpublic boolean isLeafType()
true if this entry is of type leafpublic boolean isNavigationLevelType()
true if this entry is of type folderpublic boolean isNew()
public boolean isResleasedAndNotExpired()
true if the resource is released and not expiredpublic boolean isRoot()
public boolean isSubSitemapType()
true if this entry is of type sub-sitemappublic void normalizeProperties()
public CmsClientSitemapEntry removeSubEntry(CmsUUID entryId)
entryId - the id of the child to removepublic CmsClientSitemapEntry removeSubEntry(int position)
position - the index of the child to removepublic void setAliases(java.util.List<java.lang.String> aliases)
aliases - the aliases to setpublic void setBlockingLockedChildren(boolean hasBlockingLockedChildren)
hasBlockingLockedChildren - true if the entry resource has blocking locked childrenpublic void setChildrenLoadedInitially(boolean childrenLoaded)
childrenLoaded - true if children are loaded initiallypublic void setDateExpired(java.lang.String dateExpired)
dateExpired - the expiration date to setpublic void setDateReleased(java.lang.String dateReleased)
dateReleased - the release date to setpublic void setDefaultFileId(CmsUUID defaultFileId)
defaultFileId - the new default file idpublic void setDefaultFileProperties(java.util.Map<java.lang.String,CmsClientProperty> properties)
properties - the properties for the default filepublic void setDefaultFileReleased(boolean defaultFileReleased)
defaultFileReleased - the default file is released and not expired flag to setpublic void setDefaultFileType(java.lang.String defaultFileType)
defaultFileType - the default file resource type name to setpublic void setDetailpageTypeName(java.lang.String detailpageTypeName)
detailpageTypeName - the detail resource type namepublic void setEntryType(CmsClientSitemapEntry.EntryType entryType)
entryType - the entry type to setpublic void setExportName(java.lang.String exportName)
exportName - the export name for this entrypublic void setFolderDefaultPage(boolean isFolderDefaultPage)
isFolderDefaultPage - the isFolderDefaultPage to setpublic void setHasForeignFolderLock(boolean hasForeignFolderLock)
hasForeignFolderLock - set true if the entry folder is locked by another userpublic void setInNavigation(boolean inNavigation)
inNavigation - set true for entries visible in navigationpublic void setLock(CmsClientLock lock)
lock - the lock of the entry resource to setpublic void setName(java.lang.String name)
name - the name to setpublic void setNavModeIcon(java.lang.String iconClasses)
iconClasses - the nav mode icon style classes to setpublic void setNew(boolean isNew)
isNew - the new newpublic void setOwnProperties(java.util.Map<java.lang.String,CmsClientProperty> properties)
properties - the properties for the entry itselfpublic void setPermissionInfo(CmsPermissionInfo permissionInfo)
permissionInfo - the permission info to setpublic void setPosition(int position)
position - the position to setpublic void setRedirectTarget(java.lang.String redirectTarget)
redirectTarget - the redirect target to setpublic void setResleasedAndNotExpired(boolean isResleasedAndNotExpired)
isResleasedAndNotExpired - the resource is released and not expired flagpublic void setResourceState(CmsResourceState resourceState)
resourceState - the resource state to setpublic void setResourceTypeId(int resourceTypeId)
resourceTypeId - the resource type idpublic void setResourceTypeName(java.lang.String typeName)
typeName - the resource type namepublic void setSitePath(java.lang.String sitepath)
sitepath - the site path to setpublic void setSubEntries(java.util.List<CmsClientSitemapEntry> children, I_CmsSitemapController controller)
children - the children to setcontroller - a sitemap controller instancepublic void setVfsModeIcon(java.lang.String iconClasses)
iconClasses - the vfs mode icon style classes to setpublic void setVfsPath(java.lang.String path)
path - the path to setpublic java.lang.String toString()
toString in class java.lang.ObjectObject.toString()public void update(CmsClientSitemapEntry source)
source - the source entry to update frompublic void updateSitePath(java.lang.String sitepath, I_CmsSitemapController controller)
sitepath - the new site path to setcontroller - a sitemap controller instance