com.serotonin.mango.view.component

Class ViewComponent

java.lang.Object

com.serotonin.mango.view.component.ViewComponent

All Implemented Interfaces:

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

Direct Known Subclasses:

CompoundComponent, CustomComponent, HtmlComponent, PointComponent

public abstract class ViewComponent
extends java.lang.Object
implements java.io.Serializable, com.serotonin.json.JsonSerializable

Author:

Matthew Lohbihler

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ViewComponent.Factory

Field Summary

Fields

Modifier and Type	Field and Description
private static java.util.List<ImplDefinition>	DEFINITIONS
private java.lang.String	idSuffix
private int	index
private static long	serialVersionUID
private java.lang.String	style
private static int	version
private int	x
private int	y

Constructor Summary

Constructors

Constructor and Description
ViewComponent()

Method Summary

Modifier and Type	Method and Description
abstract boolean	containsValidVisibleDataPoint(int dataPointId)
abstract ImplDefinition	definition()
java.lang.String	getDefName()
static java.util.List<java.lang.String>	getExportTypes()
java.lang.String	getId()
java.lang.String	getIdSuffix()
static java.util.List<ImplDefinition>	getImplementations()
int	getIndex()
java.lang.String	getStyle()
int	getX()
int	getY()
boolean	isCompoundComponent()
boolean	isCustomComponent()
boolean	isPointComponent()
boolean	isUnreliable()
abstract boolean	isValid()
abstract boolean	isVisible()
void	jsonDeserialize(com.serotonin.json.JsonReader reader, com.serotonin.json.JsonObject json)
protected void	jsonDeserializeDataPoint(com.serotonin.json.JsonValue jsonXid, PointComponent comp)
void	jsonSerialize(java.util.Map<java.lang.String,java.lang.Object> map)
protected void	jsonSerializeDataPoint(java.util.Map<java.lang.String,java.lang.Object> map, java.lang.String key, PointComponent comp)
static ViewComponent	newInstance(java.lang.String name)
protected DataPointVO	readDataPoint(java.io.ObjectInputStream in)
private void	readObject(java.io.ObjectInputStream in)
(package private) static java.lang.Class<? extends ViewComponent>	resolveClass(ImplDefinition def)
void	setIdSuffix(java.lang.String idSuffix)
void	setIndex(int index)
void	setLocation(int x, int y)
void	setStyle(java.lang.String style)
void	setX(int x)
void	setY(int y)
void	validate(com.serotonin.web.dwr.DwrResponseI18n response)
abstract void	validateDataPoint(User user, boolean makeReadOnly)
protected void	writeDataPoint(java.io.ObjectOutputStream out, DataPointVO dataPoint)
private void	writeObject(java.io.ObjectOutputStream out)

Methods inherited from class java.lang.Object

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

Field Detail

DEFINITIONS

private static java.util.List<ImplDefinition> DEFINITIONS

index

private int index

idSuffix

private java.lang.String idSuffix

style

private java.lang.String style

x

private int x

y

private int y

serialVersionUID

private static final long serialVersionUID

See Also:

Constant Field Values

version

private static final int version

See Also:

Constant Field Values

Constructor Detail

ViewComponent

public ViewComponent()

Method Detail

getImplementations

public static java.util.List<ImplDefinition> getImplementations()

newInstance

public static ViewComponent newInstance(java.lang.String name)

resolveClass

static java.lang.Class<? extends ViewComponent> resolveClass(ImplDefinition def)

getExportTypes

public static java.util.List<java.lang.String> getExportTypes()

setLocation

public void setLocation(int x,
                        int y)

definition

public abstract ImplDefinition definition()

validateDataPoint

public abstract void validateDataPoint(User user,
                                       boolean makeReadOnly)

isVisible

public abstract boolean isVisible()

isValid

public abstract boolean isValid()

containsValidVisibleDataPoint

public abstract boolean containsValidVisibleDataPoint(int dataPointId)

isPointComponent

public boolean isPointComponent()

isUnreliable

public boolean isUnreliable()

isCompoundComponent

public boolean isCompoundComponent()

isCustomComponent

public boolean isCustomComponent()

getDefName

public java.lang.String getDefName()

getId

public java.lang.String getId()

getIndex

public int getIndex()

setIndex

public void setIndex(int index)

getIdSuffix

public java.lang.String getIdSuffix()

setIdSuffix

public void setIdSuffix(java.lang.String idSuffix)

getX

public int getX()

setX

public void setX(int x)

getY

public int getY()

setY

public void setY(int y)

getStyle

public java.lang.String getStyle()

setStyle

public void setStyle(java.lang.String style)

validate

public void validate(com.serotonin.web.dwr.DwrResponseI18n response)

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

writeDataPoint

protected void writeDataPoint(java.io.ObjectOutputStream out,
                              DataPointVO dataPoint)
                       throws java.io.IOException

Throws:

java.io.IOException

readDataPoint

protected DataPointVO readDataPoint(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

Throws:

com.serotonin.json.JsonException

jsonSerialize

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

Specified by:

jsonSerialize in interface com.serotonin.json.JsonSerializable

jsonSerializeDataPoint

protected void jsonSerializeDataPoint(java.util.Map<java.lang.String,java.lang.Object> map,
                                      java.lang.String key,
                                      PointComponent comp)

jsonDeserializeDataPoint

protected void jsonDeserializeDataPoint(com.serotonin.json.JsonValue jsonXid,
                                        PointComponent comp)
                                 throws com.serotonin.json.JsonException

Throws:

com.serotonin.json.JsonException