com.sap.portal.pcm.layout
Interface ILayout

All Superinterfaces:

com.sap.portal.pcm.admin.IAttributeSet

public interface ILayout

extends com.sap.portal.pcm.admin.IAttributeSet

The semantic aspect of a layout object. Defines the layout object specific functionality.

Can be retreived by JNDI lookup:

Hashtable env = new Hashtable();
env.put(Constants.REQUESTED_ASPECT, PcmConstants.ASPECT_SEMANTICS);
env.put(Context.SECURITY_PRINCIPAL, user);
try
{
com.sapportals.portal.prt.jndisupport.InitialContext iCtx = new InitialContext(env);
ILayout layout = (ILayout)iCtx.lookup(name);
}
catch (NamingException e)
{
// ...
}


See Also:

IPage, ILayouts, IAttrLayout

Fields inherited from interface com.sap.portal.pcm.admin.IAttributeSet

ADMINISTRATION, ATTRIBUTE_NOT_FOUND, DIALOG, DIALOG_READ_ONLY, NONDIALOG, NONE, PERSONALIZATION, STRING_ATTRIBUTE, TEXT_ATTRIBUTE

Method Summary

java.lang.String	getContainerID(java.lang.String containerName) Get the container Id by the container name (as defined in the JSP).
java.lang.String[]	getContaineriViews(java.lang.String containerID) Get all iViews/pages of the container by their names.
java.lang.String[]	getContainersIDs() Get all layout-containers Ids.
void	setiViewInContainer(java.lang.String objName, java.lang.String containerId) Set an iView/page object in a specified container.
void	setiViewInContainer(java.lang.String objName, java.lang.String containerId, int position) Set an iView/page object in a specified container, on a specific position.

Methods inherited from interface com.sap.portal.pcm.admin.IAttributeSet

deleteAttribute, deleteMetaAttribute, getAttribute, getAttribute, getAttributeIds, getAttributeType, getAvailableAttributeLocales, getAvailableMetaAttributeLocales, getMetaAttribute, getMetaAttribute, getMetaAttributeIds, getMetaAttributeType, putAttribute, putAttribute, putMetaAttribute, putMetaAttribute, save, validate

Method Detail

getContainerID

public java.lang.String getContainerID(java.lang.String containerName)

Get the container Id by the container name (as defined in the JSP).

Parameters:

containerName - the name of the container

Returns:

String- the container Id

getContainersIDs

public java.lang.String[] getContainersIDs()

Get all layout-containers Ids.

Returns:

ArrayList- the containers Ids.

getContaineriViews

public java.lang.String[] getContaineriViews(java.lang.String containerID)

Get all iViews/pages of the container by their names.

Parameters:

containerID - the Id of the container

Returns:

String [] - list of iView/page names (relative to the page)

setiViewInContainer

public void setiViewInContainer(java.lang.String objName,
                                java.lang.String containerId)

Set an iView/page object in a specified container.
If the object already exists in another container, it will be moved.

Parameters:

iViewName - the iView/page name (relative to the page)

containerId - the container Id

setiViewInContainer

public void setiViewInContainer(java.lang.String objName,
                                java.lang.String containerId,
                                int position)

Set an iView/page object in a specified container, on a specific position.
If the object already exists in another container, it will be moved.
If the position is not valid, the object will be put in the first available position.

Parameters:

iViewName - the iView/page name (relative to the page)

containerId - the container Id

position - position in the container