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 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(String rootPath, CmsUUID structureId, String title, String iconClasses, boolean isRoot, boolean editable, List<CmsVfsEntryBean> preloadedChildren, boolean isMatch)	Creates a new VFS entry bean.

Method Summary

Modifier and Type	Method	Description
void	addChild(CmsVfsEntryBean child)	Adds a new child to the node.
String	getBigIconClasses()	Returns the big icon CSS classes.
List<CmsVfsEntryBean>	getChildren()	Gets the children of this node.
String	getDisplayName()	Gets the name which should be displayed in the widget representing this VFS entry.
String	getRootPath()	Gets the root path of the VFS entry.
String	getSiteRoot()	Gets the site root of this tree entry.
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(List<CmsVfsEntryBean> children)	Sets the list of children.
void	setEditable(boolean editable)	Sets if the user has write permissions to the folder.
void	setSiteRoot(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 Details

CmsVfsEntryBean

public CmsVfsEntryBean(String rootPath,
 CmsUUID structureId,
 String title,
 String iconClasses,
 boolean isRoot,
 boolean editable,
 List<CmsVfsEntryBean> preloadedChildren,
 boolean isMatch)

Creates a new VFS entry bean.

Parameters:

rootPath - the root path

structureId - the structure id

title - the folder title

iconClasses - the resource icon classes

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

isMatch - true if this entry bean is a search match for the filter string the user entered

CmsVfsEntryBean

protected CmsVfsEntryBean()

Hidden default constructor.

Method Details

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)

getBigIconClasses

public String getBigIconClasses()

Description copied from interface: I_CmsHasIconClasses

Returns the big icon CSS classes.

Specified by:

getBigIconClasses in interface I_CmsHasIconClasses

Returns:

the big icon CSS classes

See Also:

• I_CmsHasIconClasses.getBigIconClasses()

getChildren

public 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 String getDisplayName()

Gets the name which should be displayed in the widget representing this VFS entry.

Returns:

the name to display

getRootPath

public String getRootPath()

Gets the root path of the VFS entry.

Returns:

the root path of the VFS entry

getSiteRoot

public String getSiteRoot()

Gets the site root of this tree entry.

Returns:

the site root of this entry

getSmallIconClasses

public String getSmallIconClasses()

Description copied from interface: I_CmsHasIconClasses

Returns the small icon CSS classes.

Specified by:

getSmallIconClasses in interface I_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(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(String siteRoot)

Sets the site root of this tree entry.

Parameters:

siteRoot - the site root of this tree entry