LayoutService - JBOSS Portal 2.6 API 英文版文档

Overview

Package

Class

Tree

Deprecated

Index

Help

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

org.jboss.portal.theme
Interface LayoutService

All Superinterfaces:: LayoutServiceInfo

All Known Implementing Classes:: LayoutServiceImpl

public interface LayoutService
extends LayoutServiceInfo

TODO: A description of this class.

Version:: $Revision: 5448 $
Author:: Martin Holzner.

Method Summary

void addLayout(RuntimeContext runtimeContext, PortalLayoutMetaData layoutMD)
          Add a layout.

void addRenderSet(RuntimeContext runtimeContext, RenderSetMetaData renderSet)
          Register a renderSet with this service

void addStrategy(RuntimeContext runtimeContext, LayoutStrategyMetaData strategyMD)
          Register a a portal layout strategy with this service

void removeLayouts(java.lang.String appID)
          Remove all layouts that are hosted in the provided application.

void removeRenderSets(java.lang.String appID)
          Remove all rendersets that are hosted in the provided application.

void removeStrategies(java.lang.String appID)
          Remove all strategies that are hosted in the provided application.

void setDefaultLayout(java.lang.String name)
          Set the default layout (on a global level).

Methods inherited from interface org.jboss.portal.theme.LayoutServiceInfo

getLayout, getLayout, getLayouts, getRenderSet, getRenderSet, getRenderSet, getRenderSets, getStrategies, getStrategy, getStrategy

Method Detail

setDefaultLayout

public void setDefaultLayout(java.lang.String name)
                      throws LayoutException

Set the default layout (on a global level).

Parameters:: name - the name of the layout to set as default
Throws:: LayoutException

addLayout

public void addLayout(RuntimeContext runtimeContext,
                      PortalLayoutMetaData layoutMD)
               throws LayoutException

Add a layout.

Throws:: LayoutException

removeLayouts

public void removeLayouts(java.lang.String appID)
                   throws LayoutException

Remove all layouts that are hosted in the provided application.

Parameters:: appID - the name of the application that hosts the layout(s) to be removed
Throws:: LayoutException

addStrategy

public void addStrategy(RuntimeContext runtimeContext,
                        LayoutStrategyMetaData strategyMD)
                 throws LayoutException

Throws:: LayoutException

removeStrategies

public void removeStrategies(java.lang.String appID)
                      throws LayoutException

Remove all strategies that are hosted in the provided application.

Parameters:: appID - the name of the application that hosts the strategie(s) to be removed
Throws:: LayoutException

addRenderSet

public void addRenderSet(RuntimeContext runtimeContext,
                         RenderSetMetaData renderSet)
                  throws LayoutException

Throws:: LayoutException

removeRenderSets

public void removeRenderSets(java.lang.String appID)
                      throws LayoutException

Remove all rendersets that are hosted in the provided application.

Parameters:: appID - the name of the application that hosts the render set(s) to be removed
Throws:: LayoutException