org.osivia.portal.api.theming

Interface TabGroup

public interface TabGroup

Tab group.

Author:

Cédric Krommenhoek

Field Summary

Fields

Modifier and Type	Field and Description
static String	MAINTAINS_PROPERTY Tab group maintains visible indicator property name.
static String	NAME_PROPERTY Tab group name property name.
static String	TYPE_PROPERTY Tab group type property name.

Method Summary

Modifier and Type	Method and Description
boolean	contains(PortalControllerContext portalControllerContext, EcmDocument document, String type, Map<String,String> pageProperties) Check if this group contains this document.
String	getIcon() Get tab group icon.
String	getLabelKey() Get label internationalization key.
String	getName() Get tab group name.
boolean	maintains(PortalControllerContext portalControllerContext, EcmDocument document, String type, Map<String,String> pageProperties) Check if this group maintains visible this document.

Field Detail

NAME_PROPERTY

static final String NAME_PROPERTY

Tab group name property name.

See Also:

Constant Field Values

MAINTAINS_PROPERTY

static final String MAINTAINS_PROPERTY

Tab group maintains visible indicator property name.

See Also:

Constant Field Values

TYPE_PROPERTY

static final String TYPE_PROPERTY

Tab group type property name.

See Also:

Constant Field Values

Method Detail

getName

String getName()

Get tab group name.

Returns:

name

getIcon

String getIcon()

Get tab group icon.

Returns:

icon

getLabelKey

String getLabelKey()

Get label internationalization key.

Returns:

internationalization key

contains

boolean contains(PortalControllerContext portalControllerContext,
                 EcmDocument document,
                 String type,
                 Map<String,String> pageProperties)

Check if this group contains this document.

Parameters:

portalControllerContext - portal controller context

document - document

type - tab type

pageProperties - page properties

Returns:

true if this group contains this document, false otherwise

maintains

boolean maintains(PortalControllerContext portalControllerContext,
                  EcmDocument document,
                  String type,
                  Map<String,String> pageProperties)

Check if this group maintains visible this document.

Parameters:

portalControllerContext - portal controller context

document - document

type - tab type

pageProperties - page properties

Returns:

true if this group maintains visible this document, false otherwise