Package org.opencms.gwt.shared
Class CmsListInfoBean
- java.lang.Object
-
- org.opencms.gwt.shared.CmsIconBean
-
- org.opencms.gwt.shared.CmsListInfoBean
-
- All Implemented Interfaces:
com.google.gwt.user.client.rpc.IsSerializable
,I_CmsHasIconClasses
,I_CmsHasTitle
,I_CmsHasType
- Direct Known Subclasses:
CmsExternalLinkInfoBean
,CmsGalleryFolderBean
,CmsGalleryType
,CmsModelResourceInfo
,CmsNewResourceInfo
,CmsPublishResource
,CmsResourceTypeBean
,CmsResultItemBean
public class CmsListInfoBean extends CmsIconBean implements I_CmsHasTitle, I_CmsHasType
A bean holding all info to be displayed inorg.opencms.gwt.client.ui.CmsListItemWidget
s.- Since:
- 8.0.0
- See Also:
org.opencms.gwt.client.ui.CmsListItemWidget
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
CmsListInfoBean.LockIcon
Lock icons.static class
CmsListInfoBean.StateIcon
Enum for the type of page icon which should be displayed.
-
Field Summary
Fields Modifier and Type Field Description static java.lang.String
CSS_CLASS_MULTI_LINE
CSS class for multi-line additional info's.
-
Constructor Summary
Constructors Constructor Description CmsListInfoBean()
Default constructor.CmsListInfoBean(java.lang.String title, java.lang.String subtitle, java.util.List<CmsAdditionalInfoBean> additionalInfo)
Constructor.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description void
addAdditionalInfo(java.lang.String name, java.lang.String value)
Sets a new additional info.void
addAdditionalInfo(java.lang.String name, java.lang.String value, java.lang.String style)
Sets a new additional info.java.util.List<CmsAdditionalInfoBean>
getAdditionalInfo()
Returns the additional info.java.lang.Boolean
getIsFolder()
Returns a flag which indicates whether this info bean was generated for a folder.CmsListInfoBean.LockIcon
getLockIcon()
Returns the lock icon.java.lang.String
getLockIconTitle()
Returns the lock icon title.CmsResourceState
getResourceState()
Returns the resourceState.java.lang.String
getResourceType()
Returns the resource type name.CmsListInfoBean.StateIcon
getStateIcon()
Returns the state icon.java.lang.String
getSubTitle()
Returns the sub-title.java.lang.String
getTitle()
Returns the title.java.lang.String
getType()
Returns the type.boolean
hasAdditionalInfo()
Returns if the bean has additional info elements.boolean
isMarkChangedState()
Returns true if the 'changed' resource state should be marked by an icon.void
setAdditionalInfo(java.util.List<CmsAdditionalInfoBean> additionalInfo)
Sets the additional info.void
setIsFolder(java.lang.Boolean isFolder)
Sets thE 'isFolder' flag.void
setLockIcon(CmsListInfoBean.LockIcon lockIcon)
Sets the lock icon.void
setLockIconTitle(java.lang.String lockIconTitle)
Sets the lock icon title.void
setMarkChangedState(boolean markChanged)
Enables or disables the display of the 'changed' icon for the 'changed' resource state.void
setResourceState(CmsResourceState resourceState)
Sets the resourceState.void
setResourceType(java.lang.String resourceType)
Sets the resource type name.void
setStateIcon(CmsListInfoBean.StateIcon stateIcon)
Sets the state icon.void
setSubTitle(java.lang.String subTitle)
Sets the sub-title.void
setTitle(java.lang.String title)
Sets the title.-
Methods inherited from class org.opencms.gwt.shared.CmsIconBean
getBigIconClasses, getSmallIconClasses, setBigIconClasses, setSmallIconClasses
-
-
-
-
Field Detail
-
CSS_CLASS_MULTI_LINE
public static final java.lang.String CSS_CLASS_MULTI_LINE
CSS class for multi-line additional info's.- See Also:
- Constant Field Values
-
-
Constructor Detail
-
CmsListInfoBean
public CmsListInfoBean()
Default constructor.
-
CmsListInfoBean
public CmsListInfoBean(java.lang.String title, java.lang.String subtitle, java.util.List<CmsAdditionalInfoBean> additionalInfo)
Constructor.- Parameters:
title
- the titlesubtitle
- the subtitleadditionalInfo
- the additional info
-
-
Method Detail
-
addAdditionalInfo
public void addAdditionalInfo(java.lang.String name, java.lang.String value)
Sets a new additional info.- Parameters:
name
- the additional info namevalue
- the additional info value
-
addAdditionalInfo
public void addAdditionalInfo(java.lang.String name, java.lang.String value, java.lang.String style)
Sets a new additional info.- Parameters:
name
- the additional info namevalue
- the additional info valuestyle
- the CSS style to apply to the info
-
getAdditionalInfo
public java.util.List<CmsAdditionalInfoBean> getAdditionalInfo()
Returns the additional info.- Returns:
- the additional info
-
getIsFolder
public java.lang.Boolean getIsFolder()
Returns a flag which indicates whether this info bean was generated for a folder.This may not be set (i.e. null).
- Returns:
- a Boolean indicating whether this bean was generated for a folder
-
getLockIcon
public CmsListInfoBean.LockIcon getLockIcon()
Returns the lock icon.- Returns:
- the lockIcon
-
getLockIconTitle
public java.lang.String getLockIconTitle()
Returns the lock icon title.- Returns:
- the lock icon title
-
getResourceState
public CmsResourceState getResourceState()
Returns the resourceState.- Returns:
- the resourceState
-
getResourceType
public java.lang.String getResourceType()
Returns the resource type name.- Returns:
- the resource type name
-
getStateIcon
public CmsListInfoBean.StateIcon getStateIcon()
Returns the state icon.The state icon indicates if a resource is exported, secure etc.
- Returns:
- the state Icon
-
getSubTitle
public java.lang.String getSubTitle()
Returns the sub-title.- Returns:
- the sub-title
-
getTitle
public java.lang.String getTitle()
Returns the title.- Specified by:
getTitle
in interfaceI_CmsHasTitle
- Returns:
- the title
-
getType
public java.lang.String getType()
Description copied from interface:I_CmsHasType
Returns the type.- Specified by:
getType
in interfaceI_CmsHasType
- Returns:
- the type
- See Also:
I_CmsHasType.getType()
-
hasAdditionalInfo
public boolean hasAdditionalInfo()
Returns if the bean has additional info elements.- Returns:
true
if the bean has additional info elements
-
isMarkChangedState
public boolean isMarkChangedState()
Returns true if the 'changed' resource state should be marked by an icon.- Returns:
- true if the 'changed' resource state should be marked by an icon.
-
setAdditionalInfo
public void setAdditionalInfo(java.util.List<CmsAdditionalInfoBean> additionalInfo)
Sets the additional info.- Parameters:
additionalInfo
- the additional info to set
-
setIsFolder
public void setIsFolder(java.lang.Boolean isFolder)
Sets thE 'isFolder' flag.- Parameters:
isFolder
- the new value
-
setLockIcon
public void setLockIcon(CmsListInfoBean.LockIcon lockIcon)
Sets the lock icon.- Parameters:
lockIcon
- the lock icon to set
-
setLockIconTitle
public void setLockIconTitle(java.lang.String lockIconTitle)
Sets the lock icon title.- Parameters:
lockIconTitle
- the lock icon title to set
-
setMarkChangedState
public void setMarkChangedState(boolean markChanged)
Enables or disables the display of the 'changed' icon for the 'changed' resource state.- Parameters:
markChanged
- true if the 'changed' state should be displayed
-
setResourceState
public void setResourceState(CmsResourceState resourceState)
Sets the resourceState.- Parameters:
resourceState
- the resourceState to set
-
setResourceType
public void setResourceType(java.lang.String resourceType)
Sets the resource type name.- Parameters:
resourceType
- the resource type name to set
-
setStateIcon
public void setStateIcon(CmsListInfoBean.StateIcon stateIcon)
Sets the state icon.The state icon indicates if a resource is exported, secure etc.
- Parameters:
stateIcon
- the state icon to set
-
setSubTitle
public void setSubTitle(java.lang.String subTitle)
Sets the sub-title.- Parameters:
subTitle
- the sub-title to set
-
setTitle
public void setTitle(java.lang.String title)
Sets the title.- Parameters:
title
- the title to set
-
-