Package org.netxms.client.maps.elements

Class NetworkMapDecoration

java.lang.Object

org.netxms.client.maps.elements.NetworkMapElement

org.netxms.client.maps.elements.NetworkMapDecoration

public class NetworkMapDecoration
extends NetworkMapElement

Decoration element of network map

Field Summary

Fields

Modifier and Type	Field	Description
static final int	GROUP_BOX
static final int	IMAGE

Fields inherited from class org.netxms.client.maps.elements.NetworkMapElement

AUTO_GENERATED, id, MAP_ELEMENT_DCI_CONTAINER, MAP_ELEMENT_DCI_IMAGE, MAP_ELEMENT_DECORATION, MAP_ELEMENT_GENERIC, MAP_ELEMENT_OBJECT, MAP_ELEMENT_TEXT_BOX, type, x, y

Constructor Summary

Constructors

Modifier	Constructor	Description
	NetworkMapDecoration(long id, int decorationType)	Create new decoration object.
protected	NetworkMapDecoration(NXCPMessage msg, long baseId)	Create from NXCP message.

Method Summary

Modifier and Type	Method	Description
void	fillMessage(NXCPMessage msg, long baseId)	Fill NXCP message with element data
int	getColor()
int	getDecorationType()	Get decoration type.
int	getHeight()
String	getTitle()
int	getWidth()
void	setColor(int color)
void	setSize(int w, int h)	Set decoration size
void	setTitle(String title)

Methods inherited from class org.netxms.client.maps.elements.NetworkMapElement

addFlag, createMapElement, equals, getFlags, getId, getType, getX, getY, hashCode, removeFlag, setFlags, setLocation

Methods inherited from class java.lang.Object

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

Field Details

GROUP_BOX

public static final int GROUP_BOX

See Also:

• Constant Field Values

IMAGE

public static final int IMAGE

See Also:

• Constant Field Values

Constructor Details

NetworkMapDecoration

protected NetworkMapDecoration(NXCPMessage msg,
 long baseId)

Create from NXCP message.

Parameters:

msg - NXCP message

baseId - base field ID

NetworkMapDecoration

public NetworkMapDecoration(long id,
 int decorationType)

Create new decoration object.

Parameters:

id - map element ID

decorationType - decoration type - one of

• GROUP_BOX (show box with title that can be used for grouping map elements)
• IMAGE (arbitrary image)

Method Details

getDecorationType

public int getDecorationType()

Get decoration type.

Returns:

decoration type

getColor

public int getColor()

Returns:

the color

getTitle

public String getTitle()

Returns:

the title

setColor

public void setColor(int color)

Parameters:

color - the color to set

setTitle

public void setTitle(String title)

Parameters:

title - the title to set

fillMessage

public void fillMessage(NXCPMessage msg,
 long baseId)

Description copied from class: NetworkMapElement

Fill NXCP message with element data

Overrides:

fillMessage in class NetworkMapElement

Parameters:

msg - NXCP message

baseId - base variable ID

getWidth

public int getWidth()

Returns:

the width

getHeight

public int getHeight()

Returns:

the height

setSize

public void setSize(int w,
 int h)

Set decoration size

Parameters:

w - width

h - height