org.opencms.gwt.shared
Class CmsListInfoBean

java.lang.Object
  org.opencms.gwt.shared.CmsListInfoBean

All Implemented Interfaces:

com.google.gwt.user.client.rpc.IsSerializable

Direct Known Subclasses:

CmsModelResourceInfo, CmsResultItemBean

public class CmsListInfoBean
extends java.lang.Object
implements com.google.gwt.user.client.rpc.IsSerializable

A bean holding all info to be displayed in org.opencms.gwt.client.ui.CmsListItemWidgets.

Since:

8.0.0

See Also:

org.opencms.gwt.client.ui.CmsListItemWidget

Nested Class Summary

static class	CmsListInfoBean.LockIcon Lock icons.
static class	CmsListInfoBean.StateIcon Enum for the type of page icon which should be displayed.

Field Summary

static java.lang.String

CSS_CLASS_MULTI_LINE CSS class for multi-line additional info's.

Constructor Summary

CmsListInfoBean()
Default constructor.

CmsListInfoBean(java.lang.String title, java.lang.String subtitle, java.util.List<CmsAdditionalInfoBean> additionalInfo)
Constructor.

Method Summary

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.
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.
boolean	hasAdditionalInfo() Returns if the bean has additional info elements.
void	setAdditionalInfo(java.util.List<CmsAdditionalInfoBean> additionalInfo) Sets the additional info.
void	setLockIcon(CmsListInfoBean.LockIcon lockIcon) Sets the lock icon.
void	setLockIconTitle(java.lang.String lockIconTitle) Sets the lock icon title.
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 java.lang.Object

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

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 title

subtitle - the subtitle

additionalInfo - 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 name

value - 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 name

value - the additional info value

style - the CSS style to apply to the info

getAdditionalInfo

public java.util.List<CmsAdditionalInfoBean> getAdditionalInfo()

Returns the additional info.

Returns:

the additional info

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.

Returns:

the title

hasAdditionalInfo

public boolean hasAdditionalInfo()

Returns if the bean has additional info elements.

Returns:

true if the bean has additional info elements

setAdditionalInfo

public void setAdditionalInfo(java.util.List<CmsAdditionalInfoBean> additionalInfo)

Sets the additional info.

Parameters:

additionalInfo - the additional info to set

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

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