org.carewebframework.shell.layout

Class LayoutUtil

java.lang.Object

org.carewebframework.shell.layout.LayoutUtil

public class LayoutUtil
extends Object

Static utility class for accessing layout services.

Method Summary

Modifier and Type	Method and Description
static void	cloneLayout(LayoutIdentifier layoutId1, LayoutIdentifier layoutId2) Clone a layout.
static void	copyAttributes(Element source, Map<String,String> dest) Copy attributes from a DOM node to a map.
static void	copyAttributes(Map<String,String> source, Element dest) Copy attributes from a map to a DOM node.
static void	deleteLayout(LayoutIdentifier layoutId) Delete a layout.
static String	getLayoutContent(LayoutIdentifier layoutId) Returns the layout content.
static String	getLayoutContentByAppId(String appId) Load the layout associated with the specified application id.
static List<String>	getLayouts(boolean shared) Returns a list of saved layouts.
static ILayoutService	getLayoutService()
static boolean	layoutExists(LayoutIdentifier layoutId) Returns true if the specified layout exists.
static void	renameLayout(LayoutIdentifier layoutId, String newName) Rename a layout.
static void	saveLayout(LayoutIdentifier layoutId, String content) Saves a layout with the specified name and content.
static boolean	validateName(String name) Validates a layout name.

Methods inherited from class java.lang.Object

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

Method Detail

getLayoutService

public static ILayoutService getLayoutService()

validateName

public static boolean validateName(String name)

Validates a layout name.

Parameters:

name - Layout name to validate.

Returns:

True if the name is valid.

layoutExists

public static boolean layoutExists(LayoutIdentifier layoutId)

Returns true if the specified layout exists.

Parameters:

layoutId - The layout identifier.

Returns:

True if layout exists.

saveLayout

public static void saveLayout(LayoutIdentifier layoutId,
                              String content)

Saves a layout with the specified name and content.

Parameters:

layoutId - The layout identifier.

content - The layout content.

renameLayout

public static void renameLayout(LayoutIdentifier layoutId,
                                String newName)

Rename a layout.

Parameters:

layoutId - The original layout.

newName - The new layout name.

cloneLayout

public static void cloneLayout(LayoutIdentifier layoutId1,
                               LayoutIdentifier layoutId2)

Clone a layout.

Parameters:

layoutId1 - The original layout identifier.

layoutId2 - The new layout identifier.

deleteLayout

public static void deleteLayout(LayoutIdentifier layoutId)

Delete a layout.

Parameters:

layoutId - The layout identifier.

getLayoutContent

public static String getLayoutContent(LayoutIdentifier layoutId)

Returns the layout content.

Parameters:

layoutId - The layout identifier.

Returns:

The layout content.

getLayoutContentByAppId

public static String getLayoutContentByAppId(String appId)

Load the layout associated with the specified application id.

Parameters:

appId - An application id.

Returns:

The layout content.

getLayouts

public static List<String> getLayouts(boolean shared)

Returns a list of saved layouts.

Parameters:

shared - If true, return shared layouts; otherwise, return personal layouts.

Returns:

List of saved layouts.

copyAttributes

public static void copyAttributes(Element source,
                                  Map<String,String> dest)

Copy attributes from a DOM node to a map.

Parameters:

source - DOM node.

dest - Destination map.

copyAttributes

public static void copyAttributes(Map<String,String> source,
                                  Element dest)

Copy attributes from a map to a DOM node.

Parameters:

source - Source map.

dest - DOM node.