com.sapportals.wcm.rendering.base

Class LayoutObject

java.lang.Object
  com.sapportals.wcm.rendering.base.LayoutObject

All Implemented Interfaces:

ILayoutObject, IParameters

Direct Known Subclasses:

AbstractResourceRenderer

Deprecated. As of NetWeaver 7.1

public class LayoutObject
extends Object
implements ILayoutObject, IParameters

Field Summary

protected IParameterName[]

supportedParameterKeys Deprecated.

Fields inherited from interface com.sapportals.wcm.rendering.base.ILayoutObject

DEF_VALUE, KEY, LINE_BREAK

Constructor Summary

LayoutObject()
Deprecated. As of NetWeaver 7.1

Method Summary

Object	get(String key) Deprecated. As of NetWeaver 7.1
String	getAlias() Deprecated. As of NetWeaver 7.1
boolean	getBooleanValue(IParameterName key, boolean defaultValue) Deprecated. As of NetWeaver 7.1
boolean	getBooleanValue(String key, boolean defaultValue) Deprecated. As of NetWeaver 7.1
String	getConfiguration(String format) Deprecated. As of NetWeaver 7.1
IFlavor	getFlavor() Deprecated. As of NetWeaver 7.1
int	getIntValue(IParameterName key, int defValue) Deprecated. As of NetWeaver 7.1
int	getIntValue(String key, int defValue) Deprecated. As of NetWeaver 7.1
List	getMultiValueParameter(IParameterName key) Deprecated. As of NetWeaver 7.1
ILayoutObject	getNewInstance() Deprecated. As of NetWeaver 7.1
String	getParameter(IParameterName key) Deprecated. As of NetWeaver 7.1
boolean	getParameter(IParameterName key, boolean defaultValue) Deprecated. As of NetWeaver 7.1
int	getParameter(IParameterName key, int defaultValue) Deprecated. As of NetWeaver 7.1
String	getParameter(IParameterName key, String defaultValue) Deprecated. As of NetWeaver 7.1
com.sapportals.htmlb.enums.TextViewDesign	getParameter(IParameterName key, com.sapportals.htmlb.enums.TextViewDesign defaultValue) Deprecated. As of NetWeaver 7.1
IParameters	getParameters() Deprecated. As of NetWeaver 7.1
IParameters	getParameters(IParameterName[] keys) Deprecated. As of NetWeaver 7.1
IProxy	getProxy() Deprecated. As of NetWeaver 7.1
IParameterName[]	getSupportedParameters() Deprecated. As of NetWeaver 7.1
boolean	is508enabled() Deprecated. As of NetWeaver 7.1
boolean	isExactlyValue(IParameterName key, Object checkValue) Deprecated. As of NetWeaver 7.1
boolean	isNoOtherValue(IParameterName key, Object checkValue) Deprecated. As of NetWeaver 7.1
IParameterNameSet	parameterNames() Deprecated. As of NetWeaver 7.1
Set	parameters() Deprecated. As of NetWeaver 7.1
void	removeParameter(IParameterName key) Deprecated. As of NetWeaver 7.1
void	set508enabled(boolean imp508) Deprecated. As of NetWeaver 7.1
void	setAlias(String alias) Deprecated. As of NetWeaver 7.1
void	setFlavor(IFlavor impFlavor) Deprecated. As of NetWeaver 7.1
Boolean	setParameter(IParameterName key, boolean value) Deprecated. As of NetWeaver 7.1
Integer	setParameter(IParameterName key, int value) Deprecated. As of NetWeaver 7.1
Object	setParameter(IParameterName key, Object value) Deprecated. As of NetWeaver 7.1
String	setParameter(IParameterName key, String value) Deprecated. As of NetWeaver 7.1
com.sapportals.htmlb.enums.TextViewDesign	setParameter(IParameterName key, com.sapportals.htmlb.enums.TextViewDesign value) Deprecated. As of NetWeaver 7.1
void	setParameters(IParameters impParameters) Deprecated. As of NetWeaver 7.1
void	setProxy(IProxy proxy) Deprecated. As of NetWeaver 7.1
void	setSupportedParameters(IParameterName[] impKeys) Deprecated. As of NetWeaver 7.1

Methods inherited from class java.lang.Object

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

Field Detail

supportedParameterKeys

protected IParameterName[] supportedParameterKeys

Deprecated.

Constructor Detail

LayoutObject

public LayoutObject()

Deprecated. As of NetWeaver 7.1

Method Detail

getNewInstance

public ILayoutObject getNewInstance()

Deprecated. As of NetWeaver 7.1

Specified by:

getNewInstance in interface ILayoutObject

Returns:

a new instance of the implementing class

setProxy

public final void setProxy(IProxy proxy)

Deprecated. As of NetWeaver 7.1

This sets the IProxy, which is to accept the events, fired by the links which might be rendered by the implementing IResourceRenderer. ResourceRenderes are designed to use IUICommands to offer actions to be carried out on the displayed resource. These IUICommands will raise Exceptions or malfunction, if no proxy is set.

Specified by:

setProxy in interface ILayoutObject

Parameters:

proxy - the outermost control, which acts as a target for the IUICommands that can be rendered within the instance of an IResourceRenderer.

getProxy

public final IProxy getProxy()

Deprecated. As of NetWeaver 7.1

getSupportedParameters

public final IParameterName[] getSupportedParameters()

Deprecated. As of NetWeaver 7.1

Description copied from interface: ILayoutObject

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

Specified by:

getSupportedParameters in interface ILayoutObject

Returns:

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

See Also:

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

setSupportedParameters

public final void setSupportedParameters(IParameterName[] impKeys)

Deprecated. As of NetWeaver 7.1

getParameters

public final IParameters getParameters()

Deprecated. As of NetWeaver 7.1

Description copied from interface: ILayoutObject

returns all parameters used in this layout object.

Specified by:

getParameters in interface ILayoutObject

Returns:

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

setParameters

public final void setParameters(IParameters impParameters)

Deprecated. As of NetWeaver 7.1

Description copied from interface: ILayoutObject

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

Specified by:

setParameters in interface ILayoutObject

Parameters:

impParameters - - 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

getBooleanValue

public final boolean getBooleanValue(String key,
                                     boolean defaultValue)

Deprecated. As of NetWeaver 7.1

getBooleanValue

public final boolean getBooleanValue(IParameterName key,
                                     boolean defaultValue)

Deprecated. As of NetWeaver 7.1

getIntValue

public final int getIntValue(String key,
                             int defValue)

Deprecated. As of NetWeaver 7.1

getIntValue

public final int getIntValue(IParameterName key,
                             int defValue)

Deprecated. As of NetWeaver 7.1

is508enabled

public final boolean is508enabled()

Deprecated. As of NetWeaver 7.1

Specified by:

is508enabled in interface ILayoutObject

Returns:

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

set508enabled

public final void set508enabled(boolean imp508)

Deprecated. As of NetWeaver 7.1

getFlavor

public final IFlavor getFlavor()

Deprecated. As of NetWeaver 7.1

Specified by:

getFlavor in interface ILayoutObject

Returns:

the flavor set for the implementing class

setFlavor

public final void setFlavor(IFlavor impFlavor)

Deprecated. As of NetWeaver 7.1

Description copied from interface: ILayoutObject

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

Specified by:

setFlavor in interface ILayoutObject

getConfiguration

public final String getConfiguration(String format)

Deprecated. As of NetWeaver 7.1

Description copied from interface: ILayoutObject

returns the supported parameters and the default values the class uses

Specified by:

getConfiguration in interface ILayoutObject

setParameter

public final Object setParameter(IParameterName key,
                                 Object value)

Deprecated. As of NetWeaver 7.1

Specified by:

setParameter in interface IParameters

getMultiValueParameter

public final List getMultiValueParameter(IParameterName key)

Deprecated. As of NetWeaver 7.1

Description copied from interface: IParameters

Searches for the parameter with the specified key. If the key is not found in this parameter set, the default parameter set, and its defaults, recursively, are then checked. The method returns null if the parameter is not found. The parameter is returned as java.util.List , even if it is a single Value Parameter. The class of the returned objects in the list can be asked via key.getMetaDate().getParameterClass()

Specified by:

getMultiValueParameter in interface IParameters

Parameters:

key - the parameters key.

Returns:

the value in this parameter set with the specified key value.

setParameter

public final String setParameter(IParameterName key,
                                 String value)

Deprecated. As of NetWeaver 7.1

Description copied from interface: IParameters

Calls the map.put(key, value) method. This method is parrallel to the String getParameter(IParameterName key) method.

Specified by:

setParameter in interface ILayoutObject

Specified by:

setParameter in interface IParameters

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

Returns:

previous value associated with specified key, or null if there was no mapping for key.

setParameter

public final Integer setParameter(IParameterName key,
                                  int value)

Deprecated. As of NetWeaver 7.1

Description copied from interface: IParameters

Calls the map.put(key, value) method. This method is parrallel to the String getParameter(IParameterName key) method. Here an int can be provided. The value will be stored as String .

Specified by:

setParameter in interface IParameters

Parameters:

key - The key for the new Parameter

value - The value for the new Parameter

Returns:

previous value associated with specified key, or null if there was no mapping for key.

setParameter

public final com.sapportals.htmlb.enums.TextViewDesign setParameter(IParameterName key,
                                                                    com.sapportals.htmlb.enums.TextViewDesign value)

Deprecated. As of NetWeaver 7.1

Description copied from interface: IParameters

Calls the map.put(key, value) method. This method is parrallel to the String getParameter(IParameterName key) method. Here an TextViewDesign can be provided. The value will be stored as String .

Specified by:

setParameter in interface IParameters

Parameters:

key - The key for the new Parameter

value - The value for the new Parameter

Returns:

previous value associated with specified key, or null if there was no mapping for key.

setParameter

public final Boolean setParameter(IParameterName key,
                                  boolean value)

Deprecated. As of NetWeaver 7.1

Description copied from interface: IParameters

Calls the map.put(key, value) method. This method is parrallel to the String getParameter(IParameterName key) method. Here an int can be provided. The value will be stored as String .

Specified by:

setParameter in interface IParameters

Parameters:

key - The key for the new Parameter

value - The value for the new Parameter

Returns:

previous value associated with specified key, or null if there was no mapping for key.

get

public final Object get(String key)

Deprecated. As of NetWeaver 7.1

Description copied from interface: IParameters

Returns the value to which the specified key is mapped in this parameters set or in the default or in the default parameter set, when not found.

Specified by:

get in interface IParameters

Parameters:

key - a key of the parameter.

Returns:

the value to which the key is mapped in this parameters set; null if the key is not mapped to any value in this parameters set or in the default.

parameterNames

public final IParameterNameSet parameterNames()

Deprecated. As of NetWeaver 7.1

Description copied from interface: IParameters

Returns an enumeration of all the keys in this parameter set, including the keys in the default parameter set and all included paramters.

Specified by:

parameterNames in interface IParameters

Returns:

an enumeration of all the keys in this parameter set, including the keys in the default parameter set.

See Also:

Enumeration

parameters

public final Set parameters()

Deprecated. As of NetWeaver 7.1

Description copied from interface: IParameters

Returns a Set view of the parameters contained in this parameters set. Each element in this collection is a Map.Entry. In contrast to method entrySet() this set is not backed up by the map, but it contains all paramters accessible via this Paramters map, this means, all paramters contained in the map, in the default map and in all included parameter sets.

Specified by:

parameters in interface IParameters

Returns:

a set view of the mappings contained in this parameters set.

getParameter

public final String getParameter(IParameterName key)

Deprecated. As of NetWeaver 7.1

Description copied from interface: IParameters

Searches for the parameter with the specified key. If the key is not found in this parameter set, the default parameter set, and its defaults, recursively, are then checked. The method returns null if the parameter is not found.

Specified by:

getParameter in interface ILayoutObject

Specified by:

getParameter in interface IParameters

Parameters:

key - the parameters 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!

getParameter

public final String getParameter(IParameterName key,
                                 String defaultValue)

Deprecated. As of NetWeaver 7.1

Description copied from interface: IParameters

Searches for the parameter with the specified key. If the key is not found in this parameter set, the default parameter set, and its defaults, recursively, are then checked. The method returns the default value argument if the parameter is not found.

Specified by:

getParameter in interface IParameters

Parameters:

key - the parameters key.

Returns:

the value in this parameter set with the specified key value. TODO: Description of the incoming method parameter

getParameter

public final int getParameter(IParameterName key,
                              int defaultValue)

Deprecated. As of NetWeaver 7.1

Description copied from interface: IParameters

Searches for the parameter with the specified key. If the key is not found in this parameter set, the default parameter set, and its defaults, recursively, are then checked. The method returns the default value argument if the parameter is not found. The value is returned as int if possible.

Specified by:

getParameter in interface IParameters

Parameters:

key - the parameters key.

defaultValue - a default value.

Returns:

the value in this parameter set with the specified key value.

getParameter

public final boolean getParameter(IParameterName key,
                                  boolean defaultValue)

Deprecated. As of NetWeaver 7.1

Description copied from interface: IParameters

Searches for the parameter with the specified key. If the key is not found in this parameter set, the default parameter set, and its defaults, recursively, are then checked. The method returns the default value argument if the parameter is not found. The value is returned as boolean . The boolean returned represents the value true if the parameters value is equal, ignoring case, to the string "true" .

Example: Boolean.valueOf("True") returns true .
Example: Boolean.valueOf("yes") returns false .

Specified by:

getParameter in interface IParameters

Parameters:

key - the parameters key.

defaultValue - a default value.

Returns:

the value in this parameter set with the specified key value.

getParameter

public final com.sapportals.htmlb.enums.TextViewDesign getParameter(IParameterName key,
                                                                    com.sapportals.htmlb.enums.TextViewDesign defaultValue)

Deprecated. As of NetWeaver 7.1

Description copied from interface: IParameters

Searches for the parameter with the specified key. If the key is not found in this parameter set, the default parameter set, and its defaults, recursively, are then checked. The method returns the default value argument if the parameter is not found. The value is returned as TextViewDesign . If the stored String can not be converted into a TextViewDesign null is returned.

Specified by:

getParameter in interface IParameters

Parameters:

key - the parameters key.

defaultValue - a default value.

Returns:

the value in this parameter set with the specified key value.

isNoOtherValue

public final boolean isNoOtherValue(IParameterName key,
                                    Object checkValue)

Deprecated. As of NetWeaver 7.1

Description copied from interface: IParameters

Checks for a key if no other value than the specified value is set. The value for the specified key is searched via the Object get(String key) method an true is returned when no value is not found or the found value equals the specified value.

Specified by:

isNoOtherValue in interface IParameters

Parameters:

key - the parameters key to search

checkValue - the value to compare with

Returns:

true, if no entry is found for the specified key or if the found value equals the specified value

See Also:

IParameters.get(String key)

isExactlyValue

public final boolean isExactlyValue(IParameterName key,
                                    Object checkValue)

Deprecated. As of NetWeaver 7.1

Description copied from interface: IParameters

Checks if an entry in the set exists for the specified key, which has the specified value. The value for the specified key is searched via the Object get(String key) method an true is returned when a value is found which equals the specified value.

Specified by:

isExactlyValue in interface IParameters

Parameters:

key - the parameters key to search

checkValue - the value to compare with

Returns:

true, if a value is found which equals the specified value

See Also:

IParameters.get(String key)

getParameters

public IParameters getParameters(IParameterName[] keys)

Deprecated. As of NetWeaver 7.1

Specified by:

getParameters in interface IParameters

removeParameter

public void removeParameter(IParameterName key)

Deprecated. As of NetWeaver 7.1

Description copied from interface: IParameters

removes the parameter specified from the paramters map. Only the first level map is considered. The paramter is not removed from any default map.

Specified by:

removeParameter in interface IParameters

getAlias

public String getAlias()

Deprecated. As of NetWeaver 7.1

Specified by:

getAlias in interface ILayoutObject

Returns:

the alias

setAlias

public void setAlias(String alias)

Deprecated. As of NetWeaver 7.1

set the alias

Specified by:

setAlias in interface ILayoutObject

Access Rights

This class can be accessed from:

SC	DC	Public Part	ACH
[sap.com] KMC-CM	[sap.com] tc/km/nonwduideprecated	api	EP-KM-CM
[sap.com] KMC-WPC	[sap.com] tc/kmc/wpc/wpcfacade	api	EP-PIN-WPC-WCM