com.serotonin.mango.view.component

Class CompoundComponent

java.lang.Object

com.serotonin.mango.view.component.ViewComponent

com.serotonin.mango.view.component.CompoundComponent

All Implemented Interfaces:

com.serotonin.json.JsonSerializable, java.io.Serializable

Direct Known Subclasses:

ImageChartComponent, SimpleCompoundComponent, WirelessTempHumSensor

public abstract class CompoundComponent
extends ViewComponent

Author:

Matthew Lohbihler

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class com.serotonin.mango.view.component.ViewComponent

ViewComponent.Factory

Field Summary

Fields

Modifier and Type	Field and Description
private java.util.List<CompoundChild>	children
private java.lang.String	name
private static long	serialVersionUID
private static int	version
private boolean	visible

Constructor Summary

Constructors

Constructor and Description
CompoundComponent()

Method Summary

Modifier and Type	Method and Description
protected void	addChild(java.lang.String id, java.lang.String descriptionKey, HtmlComponent htmlComponent)
protected void	addChild(java.lang.String id, java.lang.String descriptionKey, PointComponent pointComponent, int[] dataTypesOverride)
private void	addChildImpl(java.lang.String id, java.lang.String descriptionKey, ViewComponent viewComponent, int[] dataTypesOverride)
boolean	containsValidVisibleDataPoint(int dataPointId)
PointComponent	findPointComponent(java.lang.String viewComponentId)
protected java.lang.String	generateImageChartData(java.util.ResourceBundle bundle, long duration, int width, int height, java.lang.String... childIds)
protected java.lang.String	generateImageChartData(java.util.ResourceBundle bundle, long duration, java.lang.String... childIds)
private CompoundChild	getChild(java.lang.String childId)
ViewComponent	getChildComponent(java.lang.String childId)
java.util.List<CompoundChild>	getChildComponents()
abstract java.lang.String	getImageChartData(java.util.ResourceBundle bundle)
java.lang.String	getName()
private java.util.List<java.lang.String>	getPointComponentChildIds()
abstract java.lang.String	getStaticContent()
abstract boolean	hasInfo()
protected abstract void	initialize()
boolean	isCompoundComponent()
abstract boolean	isDisplayImageChart()
boolean	isValid()
boolean	isVisible()
void	jsonDeserialize(com.serotonin.json.JsonReader reader, com.serotonin.json.JsonObject json)
void	jsonSerialize(java.util.Map<java.lang.String,java.lang.Object> map)
private void	readObject(java.io.ObjectInputStream in)
void	setDataPoint(java.lang.String childId, DataPointVO dataPoint)
void	setIndex(int index)
void	setName(java.lang.String name)
void	validateDataPoint(User user, boolean makeReadOnly)
private void	writeObject(java.io.ObjectOutputStream out)

Methods inherited from class com.serotonin.mango.view.component.ViewComponent

definition, getDefName, getExportTypes, getId, getIdSuffix, getImplementations, getIndex, getStyle, getX, getY, isCustomComponent, isPointComponent, isUnreliable, jsonDeserializeDataPoint, jsonSerializeDataPoint, newInstance, readDataPoint, resolveClass, setIdSuffix, setLocation, setStyle, setX, setY, validate, writeDataPoint

Methods inherited from class java.lang.Object

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

Field Detail

name

private java.lang.String name

children

private java.util.List<CompoundChild> children

visible

private boolean visible

serialVersionUID

private static final long serialVersionUID

See Also:

Constant Field Values

version

private static final int version

See Also:

Constant Field Values

Constructor Detail

CompoundComponent

public CompoundComponent()

Method Detail

initialize

protected abstract void initialize()

isDisplayImageChart

public abstract boolean isDisplayImageChart()

getImageChartData

public abstract java.lang.String getImageChartData(java.util.ResourceBundle bundle)

getStaticContent

public abstract java.lang.String getStaticContent()

hasInfo

public abstract boolean hasInfo()

getName

public java.lang.String getName()

setName

public void setName(java.lang.String name)

getChildComponents

public java.util.List<CompoundChild> getChildComponents()

addChild

protected void addChild(java.lang.String id,
                        java.lang.String descriptionKey,
                        HtmlComponent htmlComponent)

addChild

protected void addChild(java.lang.String id,
                        java.lang.String descriptionKey,
                        PointComponent pointComponent,
                        int[] dataTypesOverride)

addChildImpl

private void addChildImpl(java.lang.String id,
                          java.lang.String descriptionKey,
                          ViewComponent viewComponent,
                          int[] dataTypesOverride)

isCompoundComponent

public boolean isCompoundComponent()

Overrides:

isCompoundComponent in class ViewComponent

isValid

public boolean isValid()

Specified by:

isValid in class ViewComponent

isVisible

public boolean isVisible()

Specified by:

isVisible in class ViewComponent

containsValidVisibleDataPoint

public boolean containsValidVisibleDataPoint(int dataPointId)

Specified by:

containsValidVisibleDataPoint in class ViewComponent

findPointComponent

public PointComponent findPointComponent(java.lang.String viewComponentId)

validateDataPoint

public void validateDataPoint(User user,
                              boolean makeReadOnly)

Specified by:

validateDataPoint in class ViewComponent

setIndex

public void setIndex(int index)

Overrides:

setIndex in class ViewComponent

setDataPoint

public void setDataPoint(java.lang.String childId,
                         DataPointVO dataPoint)

getChildComponent

public ViewComponent getChildComponent(java.lang.String childId)

getChild

private CompoundChild getChild(java.lang.String childId)

generateImageChartData

protected java.lang.String generateImageChartData(java.util.ResourceBundle bundle,
                                                  long duration,
                                                  java.lang.String... childIds)

generateImageChartData

protected java.lang.String generateImageChartData(java.util.ResourceBundle bundle,
                                                  long duration,
                                                  int width,
                                                  int height,
                                                  java.lang.String... childIds)

writeObject

private void writeObject(java.io.ObjectOutputStream out)
                  throws java.io.IOException

Throws:

java.io.IOException

readObject

private void readObject(java.io.ObjectInputStream in)
                 throws java.io.IOException

Throws:

java.io.IOException

jsonDeserialize

public void jsonDeserialize(com.serotonin.json.JsonReader reader,
                            com.serotonin.json.JsonObject json)
                     throws com.serotonin.json.JsonException

Specified by:

jsonDeserialize in interface com.serotonin.json.JsonSerializable

Overrides:

jsonDeserialize in class ViewComponent

Throws:

com.serotonin.json.JsonException

getPointComponentChildIds

private java.util.List<java.lang.String> getPointComponentChildIds()

jsonSerialize

public void jsonSerialize(java.util.Map<java.lang.String,java.lang.Object> map)

Specified by:

jsonSerialize in interface com.serotonin.json.JsonSerializable

Overrides:

jsonSerialize in class ViewComponent