Package org.opencms.ade.galleries.shared

Class CmsGalleryFolderBean

java.lang.Object

org.opencms.gwt.shared.CmsIconBean

org.opencms.gwt.shared.CmsListInfoBean

org.opencms.ade.galleries.shared.CmsGalleryFolderBean

All Implemented Interfaces:

com.google.gwt.user.client.rpc.IsSerializable, I_CmsHasIconClasses, I_CmsHasPath, I_CmsHasTitle, I_CmsHasType

Direct Known Subclasses:

CmsGalleryTreeEntry

public class CmsGalleryFolderBean
extends CmsListInfoBean
implements I_CmsHasPath

Represents a gallery folder.

Since:

8.0.0

Nested Class Summary

Nested classes/interfaces inherited from class org.opencms.gwt.shared.CmsListInfoBean

CmsListInfoBean.LockIcon, CmsListInfoBean.StateIcon

Field Summary

Fields inherited from class org.opencms.gwt.shared.CmsListInfoBean

CSS_CLASS_MULTI_LINE

Constructor Summary

Constructors

Constructor	Description
CmsGalleryFolderBean()

Method Summary

Modifier and Type	Method	Description
ArrayList<String>	getContentTypes()	Returns the content types which can be used within this gallery type.
CmsGalleryGroup	getGroup()	Gets the gallery group.
String	getGroupLabel()	Gets the label for the gallery group.
CmsUUID	getId()	Gets the structure id.
String	getPath()	Returns the description.
String	getSubTitle()	Returns the sub-title.
String	getUploadAction()	Gets the upload action.
boolean	isEditable()	Returns the editable flag.
boolean	isOptimizable()	User can use the 'optimize gallery' dialog.
boolean	matchesFilter(String filter)	Returns if the gallery matches the given filter.
void	setContentTypes(ArrayList<String> contentTypes)	Sets the content types which can be used within this gallery type.
void	setEditable(boolean editable)	Sets if the user has write permissions to the gallery folder.
void	setGroup(CmsGalleryGroup group)	Sets the gallery group.
void	setGroupLabel(String groupLabel)	Sets the gallery group label.
void	setId(CmsUUID structureId)	Sets the structure id.
void	setOptimizable(boolean optimizable)	Enables / disables 'optimize gallery' dialog.
void	setPath(String path)	Sets the description.
void	setUploadAction(String jsFunctionName)	Sets the upload action.

Methods inherited from class org.opencms.gwt.shared.CmsListInfoBean

addAdditionalInfo, addAdditionalInfo, getAdditionalInfo, getIsFolder, getLockIcon, getLockIconTitle, getResourceState, getResourceType, getStateIcon, getTitle, getType, hasAdditionalInfo, isMarkChangedState, setAdditionalInfo, setBigIconClasses, setIsFolder, setLockIcon, setLockIconTitle, setMarkChangedState, setResourceState, setResourceType, setStateIcon, setSubTitle, setTitle

Methods inherited from class org.opencms.gwt.shared.CmsIconBean

getBigIconClasses, getSmallIconClasses, setSmallIconClasses

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

CmsGalleryFolderBean

public CmsGalleryFolderBean()

Method Details

getContentTypes

public ArrayList<String> getContentTypes()

Returns the content types which can be used within this gallery type.

Returns:

the contentTypes

getGroup

public CmsGalleryGroup getGroup()

Gets the gallery group.

Returns:

the gallery group

getGroupLabel

public String getGroupLabel()

Gets the label for the gallery group.

Returns:

the label for the gallery group

getId

public CmsUUID getId()

Gets the structure id.

Returns:

the structure id

getPath

public String getPath()

Returns the description.

Specified by:

getPath in interface I_CmsHasPath

Returns:

the description

getSubTitle

public String getSubTitle()

Description copied from class: CmsListInfoBean

Returns the sub-title.

Overrides:

getSubTitle in class CmsListInfoBean

Returns:

the sub-title

See Also:

• CmsListInfoBean.getSubTitle()

getUploadAction

public String getUploadAction()

Gets the upload action.

Returns:

the upload action

isEditable

public boolean isEditable()

Returns the editable flag. Indicate if the user has write permissions to the gallery folder.

Returns:

the editable flag

isOptimizable

public boolean isOptimizable()

User can use the 'optimize gallery' dialog.

This does not necessarily mean the user has write permissions on the gallery.

Returns:

true if the user can use the 'optimize gallery' dialog

matchesFilter

public boolean matchesFilter(String filter)

Returns if the gallery matches the given filter.

Parameters:

filter - the filter to match

Returns:

true if the gallery matches the given filter.

setContentTypes

public void setContentTypes(ArrayList<String> contentTypes)

Sets the content types which can be used within this gallery type.

Parameters:

contentTypes - the contentTypes to set

setEditable

public void setEditable(boolean editable)

Sets if the user has write permissions to the gallery folder.

Parameters:

editable - true if the user has write permissions to the gallery folder

setGroup

public void setGroup(CmsGalleryGroup group)

Sets the gallery group.

Parameters:

group - the gallery group

setGroupLabel

public void setGroupLabel(String groupLabel)

Sets the gallery group label.

Parameters:

groupLabel - the gallery group label

setId

public void setId(CmsUUID structureId)

Sets the structure id.

Parameters:

structureId - the structure id

setOptimizable

public void setOptimizable(boolean optimizable)

Enables / disables 'optimize gallery' dialog.

Parameters:

optimizable - true if the 'optimize gallery' dialog should be enabled

setPath

public void setPath(String path)

Sets the description.

Parameters:

path - the description to set

setUploadAction

public void setUploadAction(String jsFunctionName)

Sets the upload action.

Parameters:

jsFunctionName - the name of the JavaScript function to call when the upload button is pressed.