lumis.portal.presentation
Class PageRendererUtil

java.lang.Object
  lumis.portal.presentation.PageRendererUtil

public class PageRendererUtil
extends java.lang.Object

Contains utility methods to help the page render.

Since:

5.6.0

Constructor Summary

PageRendererUtil()

Method Summary

static java.util.List<java.lang.String>	getHolderServiceInterfaceInstanceIds(java.lang.String holderId, org.w3c.dom.Document layoutDocument) Returns the identifiers of the service interface instances in a holder.
static java.lang.String	getLayoutFilePath(PageWebResource pageWebResource) Returns the path to the layout file.
static org.w3c.dom.Document	getPageLayout(SessionConfig sessionConfig, PageWebResource pageWebResource, ITransaction transaction, int mode) Returns current page's layout document.
static java.util.Collection<java.lang.String>	getPageLayoutHolderIds(org.w3c.dom.Document pageLayout, PageWebResource pageWebResource) Returns a collection of holder ids for the given page layout Document if the PageWebResource has a layout file path, else returns null.
static java.lang.String	getServiceInterfaceInstanceSafeModeHTML() Returns the HTML used for a service interface instance rendering in safe mode.
static java.lang.CharSequence	renderServiceInterfaceInstance(java.lang.String serviceInterfaceInstanceId, LayoutFilePage page) Returns the HTML source code for the service interface instance instantiated on a page.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

PageRendererUtil

public PageRendererUtil()

Method Detail

getServiceInterfaceInstanceSafeModeHTML

public static java.lang.String getServiceInterfaceInstanceSafeModeHTML()

Returns the HTML used for a service interface instance rendering in safe mode.

Returns:

the HTML code.

Since:

5.6.0

renderServiceInterfaceInstance

public static java.lang.CharSequence renderServiceInterfaceInstance(java.lang.String serviceInterfaceInstanceId,
                                                                    LayoutFilePage page)

Returns the HTML source code for the service interface instance instantiated on a page.

Parameters:

serviceInterfaceInstanceId - the service interface instance identifier.

page - the page that contains the service instance to be rendered.

Returns:

the HTML source code for the service interface instance instantiated on a page.

Since:

6.0.0

getPageLayout

public static org.w3c.dom.Document getPageLayout(SessionConfig sessionConfig,
                                                 PageWebResource pageWebResource,
                                                 ITransaction transaction,
                                                 int mode)

Returns current page's layout document. Result is cached during the request's live time.

Returns:

current page's layout.

Since:

6.0.0

getHolderServiceInterfaceInstanceIds

public static java.util.List<java.lang.String> getHolderServiceInterfaceInstanceIds(java.lang.String holderId,
                                                                                    org.w3c.dom.Document layoutDocument)

Returns the identifiers of the service interface instances in a holder.

Parameters:

holderId - the holder identifier.

Returns:

the service interface instance identifiers, ordered according to their place in the holder.

Since:

6.0.0

getLayoutFilePath

public static java.lang.String getLayoutFilePath(PageWebResource pageWebResource)

Returns the path to the layout file.

Returns:

the path to the layout file, or null if no layout file is set.

Since:

6.0.0

getPageLayoutHolderIds

public static java.util.Collection<java.lang.String> getPageLayoutHolderIds(org.w3c.dom.Document pageLayout,
                                                                            PageWebResource pageWebResource)

Returns a collection of holder ids for the given page layout Document if the PageWebResource has a layout file path, else returns null.

Parameters:

pageLayout - the page layout document.

pageWebResource - the page web resource.

Returns:

A collection of holder ids for the given page layout Document if the PageWebResource has a layout file path, else returns null.

Since:

6.0.0