com.sap.workspaces.layout

Class LayoutDescriptor

java.lang.Object
  com.sap.workspaces.layout.LayoutDescriptor

public class LayoutDescriptor
extends Object

Provides a descriptor of a page layout for the purposes of its integration in the Layouts panel

Since:

1.1

Constructor Summary

LayoutDescriptor(String layoutID, String name, String description, String iconURL, String layoutXML)
Constructor of the layout descriptor

Method Summary

String	getDescription() Returns the description of the layout
String	getIconURL() Returns the URL of the icon associated with the layout
String	getLayoutID() Returns the ID of the layout
String	getLayoutXML() Returns an XML representation of the layout
String	getName() Returns the name of the layout

Methods inherited from class java.lang.Object

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

Constructor Detail

LayoutDescriptor

public LayoutDescriptor(String layoutID,
                        String name,
                        String description,
                        String iconURL,
                        String layoutXML)

Constructor of the layout descriptor

Parameters:

layoutID - the ID of the layout

name - the name of the layout

description - the description of the layout

iconURL - the URL of the icon associated with the layout

layoutXML - an XML representation of the layout

Method Detail

getDescription

public String getDescription()

Returns the description of the layout

Returns:

The description of the layout

getIconURL

public String getIconURL()

Returns the URL of the icon associated with the layout

Returns:

The URL of the icon associated with the layout

getLayoutID

public String getLayoutID()

Returns the ID of the layout

Returns:

The ID of the layout

getLayoutXML

public String getLayoutXML()

Returns an XML representation of the layout

Returns:

An XML representation of the layout

getName

public String getName()

Returns the name of the layout

Returns:

The name of the layout