Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
SAP NetWeaver '04
 PREV CLASS   NEXT CLASS FRAMES    NO FRAMES
SUMMARY:  INNER | FIELD | CONSTR | METHOD DETAIL:  FIELD | CONSTR | METHOD

com.sapportals.wcm.rendering.base
Class LayoutObject

[contained in: com.sap.km.cm.ui.flex.par - km.shared.ui.flex.base_api.jar] 
com.sapportals.wcm.rendering.base.LayoutObject
All Implemented Interfaces:
ILayoutObject
public class LayoutObject
implements ILayoutObject

Field Summary
protected  com.sapportals.wcm.repository.service.layout.customizing.IParameterName[] supportedParameterKeys
           
 
Fields inherited from interface com.sapportals.wcm.rendering.base.ILayoutObject
DEF_VALUE, KEY, LINE_BREAK
 
Constructor Summary
LayoutObject()
           
 
Method Summary
 java.lang.Object get(java.lang.String key)
           
 java.lang.String getAlias()
           
 boolean getBooleanValue(com.sapportals.wcm.repository.service.layout.customizing.IParameterName key, boolean defaultValue)
           
 boolean getBooleanValue(java.lang.String key, boolean defaultValue)
           
 java.lang.String getConfiguration(java.lang.String format)
          returns the supported parameters and the default values the class uses
 com.sapportals.wcm.repository.service.layout.customizing.flavor.IFlavor getFlavor()
           
 int getIntValue(com.sapportals.wcm.repository.service.layout.customizing.IParameterName key, int defValue)
           
 int getIntValue(java.lang.String key, int defValue)
           
 java.util.List getMultiValueParameter(com.sapportals.wcm.repository.service.layout.customizing.IParameterName key)
           
 ILayoutObject getNewInstance()
           
 java.lang.String getParameter(com.sapportals.wcm.repository.service.layout.customizing.IParameterName key)
           
 boolean getParameter(com.sapportals.wcm.repository.service.layout.customizing.IParameterName key, boolean defaultValue)
           
 int getParameter(com.sapportals.wcm.repository.service.layout.customizing.IParameterName key, int defaultValue)
           
 java.lang.String getParameter(com.sapportals.wcm.repository.service.layout.customizing.IParameterName key, java.lang.String defaultValue)
           
 com.sapportals.htmlb.enum.TextViewDesign getParameter(com.sapportals.wcm.repository.service.layout.customizing.IParameterName key, com.sapportals.htmlb.enum.TextViewDesign defaultValue)
           
 com.sapportals.wcm.repository.service.layout.customizing.IParameters getParameters()
          returns all parameters used in this layout object.
 com.sapportals.wcm.repository.service.layout.customizing.IParameters getParameters(com.sapportals.wcm.repository.service.layout.customizing.IParameterName[] keys)
           
 IProxy getProxy()
           
 com.sapportals.wcm.repository.service.layout.customizing.IParameterName[] getSupportedParameters()
          returns all parameters which are used in this layout object.
 boolean is508enabled()
           
 boolean isExactlyValue(com.sapportals.wcm.repository.service.layout.customizing.IParameterName key, java.lang.Object checkValue)
           
 boolean isNoOtherValue(com.sapportals.wcm.repository.service.layout.customizing.IParameterName key, java.lang.Object checkValue)
           
 com.sapportals.wcm.rendering.base.IParameterNameSet parameterNames()
           
 java.util.Set parameters()
           
 void removeParameter(com.sapportals.wcm.repository.service.layout.customizing.IParameterName key)
           
 void set508enabled(boolean imp508)
           
 void setAlias(java.lang.String alias)
          set the alias
 void setFlavor(com.sapportals.wcm.repository.service.layout.customizing.flavor.IFlavor impFlavor)
          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
 java.lang.Boolean setParameter(com.sapportals.wcm.repository.service.layout.customizing.IParameterName key, boolean value)
           
 java.lang.Integer setParameter(com.sapportals.wcm.repository.service.layout.customizing.IParameterName key, int value)
           
 java.lang.Object setParameter(com.sapportals.wcm.repository.service.layout.customizing.IParameterName key, java.lang.Object value)
           
 java.lang.String setParameter(com.sapportals.wcm.repository.service.layout.customizing.IParameterName key, java.lang.String value)
           
 com.sapportals.htmlb.enum.TextViewDesign setParameter(com.sapportals.wcm.repository.service.layout.customizing.IParameterName key, com.sapportals.htmlb.enum.TextViewDesign value)
           
 void setParameters(com.sapportals.wcm.repository.service.layout.customizing.IParameters impParameters)
          is called from the factory after initializing this layout object.
 void setProxy(IProxy proxy)
          This sets the IProxy, which is to accept the events, fired by the links which might be rendered by the implementing IResourceRenderer.
 void setSupportedParameters(com.sapportals.wcm.repository.service.layout.customizing.IParameterName[] impKeys)
           
 

Field Detail

supportedParameterKeys

protected com.sapportals.wcm.repository.service.layout.customizing.IParameterName[] supportedParameterKeys
Constructor Detail

LayoutObject

public LayoutObject()
Method Detail

getNewInstance

public ILayoutObject getNewInstance()
Specified by:
getNewInstance in interface ILayoutObject
Returns:
a new instance of the implementing class

setProxy

public final void setProxy(IProxy proxy)
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()

getSupportedParameters

public final com.sapportals.wcm.repository.service.layout.customizing.IParameterName[] getSupportedParameters()
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
Following copied from interface: com.sapportals.wcm.rendering.base.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(com.sapportals.wcm.repository.service.layout.customizing.IParameterName[] impKeys)

getParameters

public final com.sapportals.wcm.repository.service.layout.customizing.IParameters getParameters()
Description copied from interface: ILayoutObject
returns all parameters used in this layout object.
Specified by:
getParameters in interface ILayoutObject
Following copied from interface: com.sapportals.wcm.rendering.base.ILayoutObject
Returns:
the hashtable of all parameters that are supported and set by the implementing class

setParameters

public final void setParameters(com.sapportals.wcm.repository.service.layout.customizing.IParameters impParameters)
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
Following copied from interface: com.sapportals.wcm.rendering.base.ILayoutObject
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

getBooleanValue

public final boolean getBooleanValue(java.lang.String key,
                                     boolean defaultValue)

getBooleanValue

public final boolean getBooleanValue(com.sapportals.wcm.repository.service.layout.customizing.IParameterName key,
                                     boolean defaultValue)

getIntValue

public final int getIntValue(java.lang.String key,
                             int defValue)

getIntValue

public final int getIntValue(com.sapportals.wcm.repository.service.layout.customizing.IParameterName key,
                             int defValue)

is508enabled

public final boolean is508enabled()
Specified by:
is508enabled in interface ILayoutObject
Following copied from interface: com.sapportals.wcm.rendering.base.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)

getFlavor

public final com.sapportals.wcm.repository.service.layout.customizing.flavor.IFlavor getFlavor()
Specified by:
getFlavor in interface ILayoutObject
Following copied from interface: com.sapportals.wcm.rendering.base.ILayoutObject
Returns:
the flavor set for the implementing class

setFlavor

public final void setFlavor(com.sapportals.wcm.repository.service.layout.customizing.flavor.IFlavor impFlavor)
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 java.lang.String getConfiguration(java.lang.String format)
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 java.lang.Object setParameter(com.sapportals.wcm.repository.service.layout.customizing.IParameterName key,
                                           java.lang.Object value)

getMultiValueParameter

public final java.util.List getMultiValueParameter(com.sapportals.wcm.repository.service.layout.customizing.IParameterName key)

setParameter

public final java.lang.String setParameter(com.sapportals.wcm.repository.service.layout.customizing.IParameterName key,
                                           java.lang.String value)
Specified by:
setParameter in interface ILayoutObject
Following copied from interface: com.sapportals.wcm.rendering.base.ILayoutObject
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

setParameter

public final java.lang.Integer setParameter(com.sapportals.wcm.repository.service.layout.customizing.IParameterName key,
                                            int value)

setParameter

public final com.sapportals.htmlb.enum.TextViewDesign setParameter(com.sapportals.wcm.repository.service.layout.customizing.IParameterName key,
                                                                   com.sapportals.htmlb.enum.TextViewDesign value)

setParameter

public final java.lang.Boolean setParameter(com.sapportals.wcm.repository.service.layout.customizing.IParameterName key,
                                            boolean value)

get

public final java.lang.Object get(java.lang.String key)

parameterNames

public final com.sapportals.wcm.rendering.base.IParameterNameSet parameterNames()

parameters

public final java.util.Set parameters()

getParameter

public final java.lang.String getParameter(com.sapportals.wcm.repository.service.layout.customizing.IParameterName key)
Specified by:
getParameter in interface ILayoutObject
Following copied from interface: com.sapportals.wcm.rendering.base.ILayoutObject
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 java.lang.String getParameter(com.sapportals.wcm.repository.service.layout.customizing.IParameterName key,
                                           java.lang.String defaultValue)

getParameter

public final int getParameter(com.sapportals.wcm.repository.service.layout.customizing.IParameterName key,
                              int defaultValue)

getParameter

public final boolean getParameter(com.sapportals.wcm.repository.service.layout.customizing.IParameterName key,
                                  boolean defaultValue)

getParameter

public final com.sapportals.htmlb.enum.TextViewDesign getParameter(com.sapportals.wcm.repository.service.layout.customizing.IParameterName key,
                                                                   com.sapportals.htmlb.enum.TextViewDesign defaultValue)

isNoOtherValue

public final boolean isNoOtherValue(com.sapportals.wcm.repository.service.layout.customizing.IParameterName key,
                                    java.lang.Object checkValue)

isExactlyValue

public final boolean isExactlyValue(com.sapportals.wcm.repository.service.layout.customizing.IParameterName key,
                                    java.lang.Object checkValue)

getParameters

public com.sapportals.wcm.repository.service.layout.customizing.IParameters getParameters(com.sapportals.wcm.repository.service.layout.customizing.IParameterName[] keys)

removeParameter

public void removeParameter(com.sapportals.wcm.repository.service.layout.customizing.IParameterName key)

getAlias

public java.lang.String getAlias()
Specified by:
getAlias in interface ILayoutObject
Returns:
the alias

setAlias

public void setAlias(java.lang.String alias)
set the alias
Specified by:
setAlias in interface ILayoutObject
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
SAP NetWeaver '04
 PREV CLASS   NEXT CLASS FRAMES    NO FRAMES
SUMMARY:  INNER | FIELD | CONSTR | METHOD DETAIL:  FIELD | CONSTR | METHOD
Copyright © 2004 by SAP AG. All Rights Reserved.
SAP, R/3, mySAP, mySAP.com, xApps, xApp, SAP NetWeaver, and other SAP products and services mentioned herein as well as their respective logos are trademarks or registered trademarks of SAP AG in Germany and in several other countries all over the world. All other product and service names mentioned are the trademarks of their respective companies. Data contained in this document serves informational purposes only. National product specifications may vary.

These materials are subject to change without notice. These materials are provided by SAP AG and its affiliated companies ("SAP Group") for informational purposes only, without representation or warranty of any kind, and SAP Group shall not be liable for errors or omissions with respect to the materials. The only warranties for SAP Group products and services are those that are set forth in the express warranty statements accompanying such products and services, if any. Nothing herein should be construed as constituting an additional warranty.