org.opencms.ade.detailpage

Class CmsDetailPageInfo

java.lang.Object

org.opencms.ade.detailpage.CmsDetailPageInfo

All Implemented Interfaces:

java.io.Serializable

public class CmsDetailPageInfo
extends java.lang.Object
implements java.io.Serializable

Data bean containing the information for a detail page.

Since:

8.0.0

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	FUNCTION_PREFIX The prefix for dynamic function detail page types.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	CmsDetailPageInfo() Empty default constructor for serialization.
	CmsDetailPageInfo(CmsUUID id, java.lang.String uri, java.lang.String type, java.lang.String iconClasses) Creates a new detail page info bean.

Method Summary

Modifier and Type	Method and Description
CmsDetailPageInfo	copyAsInherited() Creates a copy of this entry, but sets the 'inherited' flag to true in the copy.
boolean	equals(java.lang.Object obj)
java.lang.String	getDisplayType() Gets the type name to display to the user.
java.lang.String	getIconClasses() Returns the resource icon style classes.
java.lang.String	getIconType() Returns the resource type name for the icon to display.
CmsUUID	getId() Returns the id of the detail page.
java.lang.String	getType() Returns the type for which the detail page is used.
java.lang.String	getUri() The original URI for the detail page.
int	hashCode()
boolean	isInherited() Returns true if the detail page entry is inherited from a parent sitemap.
static java.lang.String	removeFunctionPrefix(java.lang.String name) Removes the prefix for dynamic functions from a detail page type name.
java.lang.String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

FUNCTION_PREFIX

public static final java.lang.String FUNCTION_PREFIX

The prefix for dynamic function detail page types.

See Also:

Constant Field Values

Constructor Detail

CmsDetailPageInfo

public CmsDetailPageInfo(CmsUUID id,
                         java.lang.String uri,
                         java.lang.String type,
                         java.lang.String iconClasses)

Creates a new detail page info bean.

Parameters:

id - the id of the detail page

uri - the original URI of the page

type - the resource type for which the detail page is used

iconClasses - the resource icon style classes

CmsDetailPageInfo

protected CmsDetailPageInfo()

Empty default constructor for serialization.

Method Detail

removeFunctionPrefix

public static java.lang.String removeFunctionPrefix(java.lang.String name)

Removes the prefix for dynamic functions from a detail page type name.

Parameters:

name - the detail page type name

Returns:

the detail page type name withotu the function prefix

copyAsInherited

public CmsDetailPageInfo copyAsInherited()

Creates a copy of this entry, but sets the 'inherited' flag to true in the copy.

Returns:

the copy of this entry

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object

See Also:

Object.equals(java.lang.Object)

getDisplayType

public java.lang.String getDisplayType()

Gets the type name to display to the user.

Returns:

the type name to display

getIconClasses

public java.lang.String getIconClasses()

Returns the resource icon style classes.

Returns:

the resource icon style classes

getIconType

public java.lang.String getIconType()

Returns the resource type name for the icon to display.

Returns:

the icon resource type

getId

public CmsUUID getId()

Returns the id of the detail page.

Returns:

the id of the detail page

getType

public java.lang.String getType()

Returns the type for which the detail page is used.

Returns:

the type for which the detail page is used

getUri

public java.lang.String getUri()

The original URI for the detail page.

Returns:

the original URI for the detail page

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

See Also:

Object.hashCode()

isInherited

public boolean isInherited()

Returns true if the detail page entry is inherited from a parent sitemap.

Returns:

true if the detail page entry is inherited from a parent sitemap

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

See Also:

Object.toString()