org.osivia.portal.api.ui.layout

Interface LayoutItemsService

public interface LayoutItemsService

Layout items service interface.

Author:

Cédric Krommenhoek

Field Summary

Fields

Modifier and Type	Field and Description
static String	LINKED_ITEM_ID_WINDOW_PROPERTY Linked layout item identifier window property.
static String	MBEAN_NAME MBean name.

Method Summary

Modifier and Type	Method and Description
LayoutItem	getCurrentItem(PortalControllerContext portalControllerContext, String groupId) Get current layout item.
List<LayoutItem>	getCurrentItems(PortalControllerContext portalControllerContext) Get current layout items.
LayoutGroup	getGroup(PortalControllerContext portalControllerContext, String groupId) Get layout group.
List<LayoutGroup>	getGroups(PortalControllerContext portalControllerContext) Get layout groups.
List<LayoutItem>	getItems(PortalControllerContext portalControllerContext, String groupId) Get layout items.
boolean	isDirty(PortalControllerContext portalControllerContext, org.jboss.portal.core.model.portal.Window window) Check if window is dirty.
boolean	isSelected(PortalControllerContext portalControllerContext, String itemId) Check if layout item is selected.
void	markWindowAsRendered(PortalControllerContext portalControllerContext, org.jboss.portal.core.model.portal.Window window) Mark window as rendered, to prevent unnecessary Ajax refresh.
void	selectItem(PortalControllerContext portalControllerContext, String itemId) Select layout item.
void	setGroup(PortalControllerContext portalControllerContext, LayoutGroup group) Set layout group.

Field Detail

MBEAN_NAME

static final String MBEAN_NAME

MBean name.

See Also:

Constant Field Values

LINKED_ITEM_ID_WINDOW_PROPERTY

static final String LINKED_ITEM_ID_WINDOW_PROPERTY

Linked layout item identifier window property.

See Also:

Constant Field Values

Method Detail

getGroups

List<LayoutGroup> getGroups(PortalControllerContext portalControllerContext)
                     throws PortalException

Get layout groups.

Parameters:

portalControllerContext - portal controller context

Returns:

layout groups

Throws:

PortalException

getGroup

LayoutGroup getGroup(PortalControllerContext portalControllerContext,
                     String groupId)
              throws PortalException

Get layout group.

Parameters:

portalControllerContext - portal controller context

groupId - layout group identifier

Returns:

layout group

Throws:

PortalException

setGroup

void setGroup(PortalControllerContext portalControllerContext,
              LayoutGroup group)
       throws PortalException

Set layout group.

Parameters:

portalControllerContext - portal controller context

group - layout group

Throws:

PortalException

getItems

List<LayoutItem> getItems(PortalControllerContext portalControllerContext,
                          String groupId)
                   throws PortalException

Get layout items.

Parameters:

portalControllerContext - portal controller context

groupId - layout group identifier

Returns:

layout items

Throws:

PortalException

getCurrentItems

List<LayoutItem> getCurrentItems(PortalControllerContext portalControllerContext)
                          throws PortalException

Get current layout items.

Parameters:

portalControllerContext - portal controller context

Returns:

layout items

Throws:

PortalException

getCurrentItem

LayoutItem getCurrentItem(PortalControllerContext portalControllerContext,
                          String groupId)
                   throws PortalException

Get current layout item.

Parameters:

portalControllerContext - portal controller context

Returns:

layout item

Throws:

PortalException

selectItem

void selectItem(PortalControllerContext portalControllerContext,
                String itemId)
         throws PortalException

Select layout item.

Parameters:

portalControllerContext - portal controller context

itemId - layout item identifier

Throws:

PortalException

isSelected

boolean isSelected(PortalControllerContext portalControllerContext,
                   String itemId)
            throws PortalException

Check if layout item is selected.

Parameters:

portalControllerContext - portal controller context

itemId - layout item identifier

Returns:

true if layout item is selected

Throws:

PortalException

markWindowAsRendered

void markWindowAsRendered(PortalControllerContext portalControllerContext,
                          org.jboss.portal.core.model.portal.Window window)
                   throws PortalException

Mark window as rendered, to prevent unnecessary Ajax refresh.

Parameters:

portalControllerContext - portal controller context

window - window

Throws:

PortalException

isDirty

boolean isDirty(PortalControllerContext portalControllerContext,
                org.jboss.portal.core.model.portal.Window window)
         throws PortalException

Check if window is dirty.

Parameters:

portalControllerContext - portal controller context

window - window

Returns:

true if window is dirty

Throws:

PortalException