Package org.netxms.client.maps.elements
Class NetworkMapDCIContainer
java.lang.Object
org.netxms.client.maps.elements.NetworkMapElement
org.netxms.client.maps.elements.NetworkMapDCIContainer
Network map element representing NetXMS DCI container.
-
Field Summary
Fields inherited from class org.netxms.client.maps.elements.NetworkMapElement
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
ModifierConstructorDescriptionNetworkMapDCIContainer
(long id) Create new DCI container element.protected
NetworkMapDCIContainer
(NXCPMessage msg, long baseId) Create DCI container from NXCP message. -
Method Summary
Modifier and TypeMethodDescriptionvoid
fillMessage
(NXCPMessage msg, long baseId) Fill NXCP message with element dataint
Get background color.int
Get border color.Get configured DCIs as list.Get DCI list for this container.int
Get text color.boolean
Check if container has any data to display.boolean
Check if "show border" flag is set for this element.void
setBackgroundColor
(int backgroundColor) Set background color (in BGR format).void
setBorderColor
(int borderColor) Set border color (in BGR format).void
setBorderRequired
(boolean borderRequired) Set "show border" flag.void
setObjectDCIArray
(SingleDciConfig[] dciArray) Set DCI list for this container.void
setTextColor
(int textColor) Set text color (in BGR format).Methods inherited from class org.netxms.client.maps.elements.NetworkMapElement
addFlag, createMapElement, equals, getFlags, getId, getType, getX, getY, hashCode, removeFlag, setFlags, setLocation
-
Constructor Details
-
NetworkMapDCIContainer
Create DCI container from NXCP message.- Parameters:
msg
- NXCP messagebaseId
- base field ID
-
NetworkMapDCIContainer
public NetworkMapDCIContainer(long id) Create new DCI container element.- Parameters:
id
- element ID
-
-
Method Details
-
fillMessage
Description copied from class:NetworkMapElement
Fill NXCP message with element data- Overrides:
fillMessage
in classNetworkMapElement
- Parameters:
msg
- NXCP messagebaseId
- base variable ID- See Also:
-
hasDciData
public boolean hasDciData()Check if container has any data to display.- Returns:
- returns if DCI list is not empty
-
getObjectDCIArray
Get DCI list for this container. Returned array is owned by container and changes to it will be reflected in container.- Returns:
- DCI list for this container
-
setObjectDCIArray
Set DCI list for this container. Container will become owner of the list.- Parameters:
dciArray
- DCI list for this container
-
getDciAsList
Get configured DCIs as list. Changes to returned list object will not affect container configuration.- Returns:
- configured DCIs as list
-
getBackgroundColor
public int getBackgroundColor()Get background color.- Returns:
- background color in BGR format
-
setBackgroundColor
public void setBackgroundColor(int backgroundColor) Set background color (in BGR format).- Parameters:
backgroundColor
- new background color in BGR format
-
getTextColor
public int getTextColor()Get text color.- Returns:
- text color in BGR format
-
setTextColor
public void setTextColor(int textColor) Set text color (in BGR format).- Parameters:
textColor
- new text color in BGR format
-
getBorderColor
public int getBorderColor()Get border color.- Returns:
- border color in BGR format
-
setBorderColor
public void setBorderColor(int borderColor) Set border color (in BGR format).- Parameters:
borderColor
- new border color in BGR format
-
isBorderRequired
public boolean isBorderRequired()Check if "show border" flag is set for this element.- Returns:
- true if "show border" flag is set
-
setBorderRequired
public void setBorderRequired(boolean borderRequired) Set "show border" flag.- Parameters:
borderRequired
- true if border should be shown
-