Package org.opencms.ade.galleries.shared
Class CmsVfsEntryBean
- java.lang.Object
-
- org.opencms.ade.galleries.shared.CmsVfsEntryBean
-
- All Implemented Interfaces:
com.google.gwt.user.client.rpc.IsSerializable
,I_CmsGalleryTreeEntry<CmsVfsEntryBean>
,I_CmsHasIconClasses
public class CmsVfsEntryBean extends java.lang.Object implements com.google.gwt.user.client.rpc.IsSerializable, I_CmsGalleryTreeEntry<CmsVfsEntryBean>, I_CmsHasIconClasses
Represents a single VFS resource entry for use by the VFS tab of the galleries.
-
-
Constructor Summary
Constructors Modifier Constructor Description protected
CmsVfsEntryBean()
Hidden default constructor.CmsVfsEntryBean(java.lang.String rootPath, CmsUUID structureId, java.lang.String title, java.lang.String iconClasses, boolean isRoot, boolean editable, java.util.List<CmsVfsEntryBean> preloadedChildren, boolean isMatch)
Creates a new VFS entry bean.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description void
addChild(CmsVfsEntryBean child)
Adds a new child to the node.java.lang.String
getBigIconClasses()
Returns the big icon CSS classes.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.java.lang.String
getSmallIconClasses()
Returns the small icon CSS classes.CmsUUID
getStructureId()
Returns the structure id.boolean
isEditable()
Returns the editable flag.boolean
isRoot()
Returns true if this entry is a top-level entry.boolean
isSearchMatch()
Returns true if this entry bean is a search match.void
setChildren(java.util.List<CmsVfsEntryBean> children)
Sets the list of children.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.
-
-
-
Constructor Detail
-
CmsVfsEntryBean
public CmsVfsEntryBean(java.lang.String rootPath, CmsUUID structureId, java.lang.String title, java.lang.String iconClasses, boolean isRoot, boolean editable, java.util.List<CmsVfsEntryBean> preloadedChildren, boolean isMatch)
Creates a new VFS entry bean.- Parameters:
rootPath
- the root pathstructureId
- the structure idtitle
- the folder titleiconClasses
- the resource icon classesisRoot
- flag indicating whether this is entry should be displayed at the top level of the treeeditable
-true
if the user has write permissions to the folderpreloadedChildren
- the preloaded child nodesisMatch
- true if this entry bean is a search match for the filter string the user entered
-
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 interfaceI_CmsGalleryTreeEntry<CmsVfsEntryBean>
- Parameters:
child
- the child to add- See Also:
I_CmsGalleryTreeEntry.addChild(java.lang.Object)
-
getBigIconClasses
public java.lang.String getBigIconClasses()
Description copied from interface:I_CmsHasIconClasses
Returns the big icon CSS classes.- Specified by:
getBigIconClasses
in interfaceI_CmsHasIconClasses
- Returns:
- the big icon CSS classes
- See Also:
I_CmsHasIconClasses.getBigIconClasses()
-
getChildren
public java.util.List<CmsVfsEntryBean> getChildren()
Description copied from interface:I_CmsGalleryTreeEntry
Gets the children of this node.- Specified by:
getChildren
in interfaceI_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
-
getSmallIconClasses
public java.lang.String getSmallIconClasses()
Description copied from interface:I_CmsHasIconClasses
Returns the small icon CSS classes.- Specified by:
getSmallIconClasses
in interfaceI_CmsHasIconClasses
- Returns:
- the small icon CSS classes
- See Also:
I_CmsHasIconClasses.getSmallIconClasses()
-
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
-
isSearchMatch
public boolean isSearchMatch()
Returns true if this entry bean is a search match.- Returns:
- true if this is a search match
-
setChildren
public void setChildren(java.util.List<CmsVfsEntryBean> children)
Sets the list of children.- Parameters:
children
- the list of children
-
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
-
-