com.sapportals.wcm.rendering.base

Interface ILayoutObject

All Known Subinterfaces:

ICollectionRenderer, IResourceRenderer

All Known Implementing Classes:

AbstractCollectionRenderer, AbstractResourceRenderer, LayoutObject, LightCollectionRenderer

public interface ILayoutObject

Field Summary

static String	DEF_VALUE
static String	KEY
static String	LINE_BREAK

Method Summary

String	getAlias()
String	getConfiguration(String format) returns the supported parameters and the default values the class uses
IFlavor	getFlavor()
ILayoutObject	getNewInstance()
String	getParameter(IParameterName key)
IParameters	getParameters() returns all parameters used in this layout object.
IParameterName[]	getSupportedParameters() returns all parameters which are used in this layout object.
boolean	is508enabled()
void	setAlias(String alias)
void	setFlavor(IFlavor flavor) is called from the factory after instantiating a new layout object to set the flavor information coming from the Control or ILayoutController , asking for special instances of the IResourceRenderer used by the implementing class
String	setParameter(IParameterName key, String value)
void	setParameters(IParameters parameters) is called from the factory after initializing this layout object.
void	setProxy(IProxy proxy) is called from the factory after instantiating a new layout object to set the proxy which is needed as possible target for actions.

Field Detail

LINE_BREAK

public static final String LINE_BREAK

KEY

public static final String KEY

See Also:

Constant Field Values

DEF_VALUE

public static final String DEF_VALUE

See Also:

Constant Field Values

Method Detail

getNewInstance

public ILayoutObject getNewInstance()

Returns:

a new instance of the implementing class

setProxy

public void setProxy(IProxy proxy)

is called from the factory after instantiating a new layout object to set the proxy which is needed as possible target for actions. ICollectionRenderer can use IResourceRenderer and IUICommand to render the given resource. These classes need the proxy for the rendering of their links. The implementing class needs the proxy to retrieve these classes using the respecting factory-classes ResourceRendererFactory and UICommandFactory

Parameters:

proxy - the WdfPfoxy that acts as an outer container for the rendering

getSupportedParameters

public IParameterName[] getSupportedParameters()

returns all parameters which are used in this layout object. Only parameters listed here will be set from the factory.

Returns:

a collection of all parameters that are used in the instance of the implementing class to modify the rendered output.

See Also:

setParameters(com.sapportals.wcm.repository.service.layout.customizing.IParameters)

getParameters

public IParameters getParameters()

returns all parameters used in this layout object.

Returns:

the hashtable of all parameters that are supported and set by the implementing class

setParameters

public void setParameters(IParameters parameters)

is called from the factory after initializing this layout object. Only parameters listed in the IParameterName[] getSupportedParameters() are set by the factory. With this method the rendering of the implementing class can be influenced. Classes can - but do not have to - react on the parameters supplied in this method

Parameters:

parameters - - the parameters retrieved from different sources (iView, OTH...) that influence the way the implementing class renders its output. If the parameter is not found in the class' getSupportedParameters, the value will not be set as parameter for this class. If for a certain key, no value is found in the given IParameters, the default value set in the class will not be overwritten. Example: The class returns as supported parameters the keys "A", "B". It has set the default parameters, so we find the key-value pairs: "A" -> a "B" -> b This method is called, with the following hashtable entries: "A" -> aa "C" -> cc After the method is called, the class holds following key-vlaue pairs: "A" -> aa (overwritten by passed hashtable values) "B" -> b (not overwritten, because the hashtable returned null for this key The key-value pair "C" -> cc is not used in the class, because the key was not found in its getSupportedParameters

setParameter

public String setParameter(IParameterName key,
                           String value)

Parameters:

key - - the key of the parameter

value - - the value of the parameter Overwrites an existing entry of the parameters or adds it, if it is not set. Note: The Layout Object may not act on this parameter. To retrieve a list of supported parameters from an ILayoutObject instance

getParameter

public String getParameter(IParameterName key)

Returns:

the current entry for the given key or null. Note: a returned null does not indicate, that the ILayoutObject does not support this parameter!

getConfiguration

public String getConfiguration(String format)

returns the supported parameters and the default values the class uses

is508enabled

public boolean is508enabled()

Returns:

flag, if this class renders its output in a way that is suited for blind people of people with viewing disabilities

setFlavor

public void setFlavor(IFlavor flavor)

is called from the factory after instantiating a new layout object to set the flavor information coming from the Control or ILayoutController , asking for special instances of the IResourceRenderer used by the implementing class

getFlavor

public IFlavor getFlavor()

Returns:

the flavor set for the implementing class

getAlias

public String getAlias()

setAlias

public void setAlias(String alias)