com.sap.netweaver.bc.uwl.config

Class ImageMapping.ImageMap

java.lang.Object
  com.sap.netweaver.bc.uwl.config.ImageMapping.ImageMap

All Implemented Interfaces:

Cloneable, Serializable

Enclosing class:

ImageMapping

public static class ImageMapping.ImageMap

extends Object

implements Cloneable, Serializable

Class for the ImageMapping. This is the one to one mapping, which will indicate the icon to use for the specified item data.

See Also:

Serialized Form

Constructor Summary

ImageMapping.ImageMap(String name, String imageName, Descriptions desc)
Constructor to create a ImageMap.

Method Summary

Object	clone()
protected boolean	equals(ImageMapping.ImageMap map) This is used to determine if two data mappings match.
Descriptions	getDescriptions() This is used to get the Description for the ImageMap.
String	getImageName() This is used to get the Image name to be used.
String	getKeyValue() This is the data which is used to compare with the item data to determine if there is a required mapping.
String	getLongText(Locale locale)
String	getShortText(Locale locale)
boolean	isImageMap() This is used to determine if an image was specified or not.
void	setDescriptions(Descriptions descriptions)
void	setImageName(String string)
void	setKeyValue(String string)

Methods inherited from class java.lang.Object

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

Constructor Detail

ImageMapping.ImageMap

public ImageMapping.ImageMap(String name,
                             String imageName,
                             Descriptions desc)

Constructor to create a ImageMap.

Parameters:

name - - This is the data for the Item which needs to be mapped

imageName - - This is the image to use if the name above matches the item data. This can be null if a defferent text mapping is required.

desc - - This is used if text mapping is required, can be null if not required.

Method Detail

equals

protected boolean equals(ImageMapping.ImageMap map)

This is used to determine if two data mappings match. This is used internally.

Parameters:

map -

Returns:

getShortText

public String getShortText(Locale locale)

Parameters:

locale -

Returns:

getLongText

public String getLongText(Locale locale)

Parameters:

locale -

Returns:

getDescriptions

public Descriptions getDescriptions()

This is used to get the Description for the ImageMap.

Returns:

Null can be returned if it is not required

getImageName

public String getImageName()

This is used to get the Image name to be used.

Returns:

Null could be returned if text mapping is required

getKeyValue

public String getKeyValue()

This is the data which is used to compare with the item data to determine if there is a required mapping.

Returns:

setDescriptions

public void setDescriptions(Descriptions descriptions)

Parameters:

descriptions -

setImageName

public void setImageName(String string)

Parameters:

string -

setKeyValue

public void setKeyValue(String string)

Parameters:

string -

isImageMap

public boolean isImageMap()

This is used to determine if an image was specified or not.

Returns:

clone

public Object clone()
             throws CloneNotSupportedException

Throws:

CloneNotSupportedException