当前页面: 在线文档首页 > JBOSS Portal 2.4 API 英文版文档

LayoutServiceInfo - JBOSS Portal 2.4 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 LayoutServiceInfo

All Known Subinterfaces:

LayoutService

All Known Implementing Classes:

LayoutServiceImpl

---

public interface LayoutServiceInfo

Read Only information about the layout service.

---

Method Summary
PortalLayout	getLayout(ServerRegistrationID id, boolean defaultOnNull)           Get the layout for the provided registration id.
PortalLayout	getLayout(java.lang.String name, boolean defaultOnNull)           Get the layout for the provided name.
java.util.Collection	getLayouts()           Get a Set of portal layouts
PortalRenderSet	getRenderSet(LayoutInfo info, HTTPStreamInfo streamInfo, MarkupResult result)
PortalRenderSet	getRenderSet(ServerRegistrationID id, MediaType mediaType)           Retrieves the render set for this Layout.
PortalRenderSet	getRenderSet(java.lang.String renderSetName, MediaType mediaType)           Get the render set for the provided layout.
java.util.Collection	getRenderSets()           Retrieves the set of the ServerRegistrationID for registred render set
java.util.Collection	getStrategies()           Get a Set of all available portal layout strategies
LayoutStrategy	getStrategy(ServerRegistrationID id, MediaType mediaType)           Retrieves the strategy for this Layout.
LayoutStrategy	getStrategy(java.lang.String strategyName, MediaType mediaType)           Get the layout strategy that matches the provided name and media type

 

Method Detail

getLayout

public PortalLayout getLayout(ServerRegistrationID id,
                              boolean defaultOnNull)

Get the layout for the provided registration id.

Parameters:

id - the registration id of the layout to get

defaultOnNull - true, if the default layout (if any is defined) should be returned in case the requested layout is not found

Returns:

the requested layout , of the default layout, or null

---

getLayout

public PortalLayout getLayout(java.lang.String name,
                              boolean defaultOnNull)

Get the layout for the provided name.

Parameters:

name - the name of the layout to request

defaultOnNull - true, if the default layout (if any is defined) should be returned in case the requested layout is not found

Returns:

the requested layout , of the default layout, or null

---

getStrategy

public LayoutStrategy getStrategy(java.lang.String strategyName,
                                  MediaType mediaType)

Get the layout strategy that matches the provided name and media type

Parameters:

strategyName - the name of the strategy to get

mediaType - the media type (content-type) to get the strategy for

Returns:

the layout strategy that matches the provided name and mediatype, or null if no such strategy is registered

---

getStrategy

public LayoutStrategy getStrategy(ServerRegistrationID id,
                                  MediaType mediaType)

Retrieves the strategy for this Layout.

Parameters:

id - the registration id of the strategy to retrieve.

mediaType - the media type that must be supported by the strategy to be retrieved

Returns:

the registered strategy identified by the specified id and media type, null otherwise.

Since:

2.4

---

getRenderSet

public PortalRenderSet getRenderSet(java.lang.String renderSetName,
                                    MediaType mediaType)

Get the render set for the provided layout.

Parameters:

renderSetName - the name of the renderSet to find

mediaType - the mediatype for which to find the renderSet

Returns:

the registered renderSet for the provided name and media type, or null if no such renderSet is registered

---

getRenderSet

public PortalRenderSet getRenderSet(ServerRegistrationID id,
                                    MediaType mediaType)

Retrieves the render set for this Layout.

Parameters:

id - the registration id of the RenderSet to retrieve.

mediaType - the media type that must be supported by the RenderSet to be retrieved

Returns:

the registered RenderSet identified by the specified id and media type, null otherwise.

Since:

2.4

---

getLayouts

public java.util.Collection getLayouts()

Get a Set of portal layouts

Returns:

a Set of portal layouts

---

getStrategies

public java.util.Collection getStrategies()

Get a Set of all available portal layout strategies

Returns:

the set of the ServerRegistrationID for registred layout strategies

---

getRenderSets

public java.util.Collection getRenderSets()

Retrieves the set of the ServerRegistrationID for registred render set

Returns:

the set of the ServerRegistrationID for registred render set

---

getRenderSet

public PortalRenderSet getRenderSet(LayoutInfo info,
                                    HTTPStreamInfo streamInfo,
                                    MarkupResult result)

---

Overview  Package   Class  Tree  Deprecated  Index  Help
PREV CLASS   NEXT CLASS	FRAMES    NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD	DETAIL: FIELD | CONSTR | METHOD

---