org.opencms.ade.galleries.shared
Class CmsVfsEntryBean

java.lang.Object
  extended by org.opencms.ade.galleries.shared.CmsVfsEntryBean
All Implemented Interfaces:
com.google.gwt.user.client.rpc.IsSerializable, I_CmsGalleryTreeEntry<CmsVfsEntryBean>

public class CmsVfsEntryBean
extends java.lang.Object
implements com.google.gwt.user.client.rpc.IsSerializable, I_CmsGalleryTreeEntry<CmsVfsEntryBean>

Represents a single VFS resource entry for use by the VFS tab of the galleries.


Constructor Summary
protected CmsVfsEntryBean()
          Hidden default constructor.
  CmsVfsEntryBean(java.lang.String rootPath, CmsUUID structureId, java.lang.String title, boolean isRoot, boolean editable, java.util.List<CmsVfsEntryBean> preloadedChildren)
          Creates a new VFS entry bean.
 
Method Summary
 void addChild(CmsVfsEntryBean child)
          Adds a new child to the node.
 java.util.List<CmsVfsEntryBean> getChildren()
          Gets the children of this node.
 java.lang.String getDisplayName()
          Gets the name which should be displayed in the widget representing this VFS entry.
 java.lang.String getRootPath()
          Gets the root path of the VFS entry.
 java.lang.String getSiteRoot()
          Gets the site root of this tree entry.
 CmsUUID getStructureId()
          Returns the structure id.
 boolean isEditable()
          Returns the editable flag.
 boolean isRoot()
          Returns true if this entry is a top-level entry.
 void setEditable(boolean editable)
          Sets if the user has write permissions to the folder.
 void setSiteRoot(java.lang.String siteRoot)
          Sets the site root of this tree entry.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

CmsVfsEntryBean

public CmsVfsEntryBean(java.lang.String rootPath,
                       CmsUUID structureId,
                       java.lang.String title,
                       boolean isRoot,
                       boolean editable,
                       java.util.List<CmsVfsEntryBean> preloadedChildren)
Creates a new VFS entry bean.

Parameters:
rootPath - the root path
structureId - the structure id
title - the folder title
isRoot - flag indicating whether this is entry should be displayed at the top level of the tree
editable - true if the user has write permissions to the folder
preloadedChildren - the preloaded child nodes

CmsVfsEntryBean

protected CmsVfsEntryBean()
Hidden default constructor.

Method Detail

addChild

public void addChild(CmsVfsEntryBean child)
Description copied from interface: I_CmsGalleryTreeEntry
Adds a new child to the node.

Specified by:
addChild in interface I_CmsGalleryTreeEntry<CmsVfsEntryBean>
Parameters:
child - the child to add
See Also:
I_CmsGalleryTreeEntry.addChild(java.lang.Object)

getChildren

public java.util.List<CmsVfsEntryBean> getChildren()
Description copied from interface: I_CmsGalleryTreeEntry
Gets the children of this node.

Specified by:
getChildren in interface I_CmsGalleryTreeEntry<CmsVfsEntryBean>
Returns:
the children of this node
See Also:
I_CmsGalleryTreeEntry.getChildren()

getDisplayName

public java.lang.String getDisplayName()
Gets the name which should be displayed in the widget representing this VFS entry.

Returns:
the name to display

getRootPath

public java.lang.String getRootPath()
Gets the root path of the VFS entry.

Returns:
the root path of the VFS entry

getSiteRoot

public java.lang.String getSiteRoot()
Gets the site root of this tree entry.

Returns:
the site root of this entry

getStructureId

public CmsUUID getStructureId()
Returns the structure id.

Returns:
the structure id

isEditable

public boolean isEditable()
Returns the editable flag. Indicate if the user has write permissions to the folder.

Returns:
the editable flag

isRoot

public boolean isRoot()
Returns true if this entry is a top-level entry.

Returns:
true if this is a top-level entry

setEditable

public void setEditable(boolean editable)
Sets if the user has write permissions to the folder.

Parameters:
editable - true if the user has write permissions to the folder

setSiteRoot

public void setSiteRoot(java.lang.String siteRoot)
Sets the site root of this tree entry.

Parameters:
siteRoot - the site root of this tree entry