org.carewebframework.shell.layout

Class LayoutParser

java.lang.Object

org.carewebframework.shell.layout.LayoutParser

public class LayoutParser
extends Object

Parses an XML layout. A number of data sources are supported.

Method Summary

Modifier and Type	Method and Description
static Layout	parseAppId(String appId) Parse the layout associated with the specified application id.
static Layout	parseDocument(Document document) Parse the layout from an XML document.
static Layout	parseElement(ElementBase root) Parse the layout from the UI.
static Layout	parseProperty(LayoutIdentifier layoutId) Parse the layout from a stored layout.
static Layout	parseResource(String resource) Loads a layout from the specified resource, using a registered layout loader or, failing that, using the default loadFromUrl method.
static Layout	parseStream(InputStream stream) Parse layout from an input stream.
static Layout	parseText(String xml) Parse the layout from XML content.

Methods inherited from class java.lang.Object

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

Method Detail

parseResource

public static Layout parseResource(String resource)

Loads a layout from the specified resource, using a registered layout loader or, failing that, using the default loadFromUrl method.

Parameters:

resource - The resource to be loaded.

Returns:

The loaded layout.

parseText

public static Layout parseText(String xml)

Parse the layout from XML content.

Parameters:

xml - The XML content to parse.

Returns:

The root layout element.

parseStream

public static Layout parseStream(InputStream stream)

Parse layout from an input stream.

Parameters:

stream - The input stream.

Returns:

The root layout element.

parseProperty

public static Layout parseProperty(LayoutIdentifier layoutId)

Parse the layout from a stored layout.

Parameters:

layoutId - Layout identifier.

Returns:

The root layout element.

parseAppId

public static Layout parseAppId(String appId)

Parse the layout associated with the specified application id.

Parameters:

appId - An application id.

Returns:

The root layout element.

parseDocument

public static Layout parseDocument(Document document)

Parse the layout from an XML document.

Parameters:

document - An XML document.

Returns:

The root layout element.

parseElement

public static Layout parseElement(ElementBase root)

Parse the layout from the UI.

Parameters:

root - Root UI element.

Returns:

The root layout element.