Package com.inductiveautomation.factorypmi.application.components.chart.easychart

Class Pen

java.lang.Object

com.inductiveautomation.factorypmi.application.components.chart.easychart.Pen

All Implemented Interfaces:

java.lang.Comparable<Pen>

Direct Known Subclasses:

CalcPen, DBPen, TagPen

public abstract class Pen
extends java.lang.Object
implements java.lang.Comparable<Pen>

A pen is the main unit of configuration for the EasyChart. Each pen will draw one line/series on the chart if enabled.

Constructor Summary

Constructors

Constructor	Description
Pen()	Creates a blank pen, using the default values for all attributes that apply to this pen's type.
Pen(Pen copy)
Pen(Dataset ds, int row)	Creates a pen object from the given dataset/row, pulling values for all attributes that apply to this pen's type

Method Summary

Modifier and Type	Method	Description
int	compareTo(Pen o)
java.lang.Object	get(PenAttribute attr)
boolean	getBoolean(PenAttribute attr)
java.awt.Color	getColor(PenAttribute attr)
abstract IPenDatasourceFactory	getDataGrouping(java.util.Set<java.lang.String> dynamicGroups)	An object that is hashable and unique to any parameters required to pull the data for this pen
float	getFloat(PenAttribute attr)
java.lang.String	getGroupAndName()	Returns the pen's group and name together as "Group\Name" or just "Name" if the group is blank.
int	getInt(PenAttribute attr)
java.lang.String	getName()
java.lang.Integer	getSortOrder()
java.lang.String	getString(PenAttribute attr)
abstract PenType	getType()
void	set(PenAttribute attr, java.lang.Object value)
static Dataset	toDataset(java.util.List<Pen> pens, PenAttribute[] penAttributes, PenType type)	Creates a dataset that represents the given list.
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

Pen

public Pen(Dataset ds,
           int row)

Creates a pen object from the given dataset/row, pulling values for all attributes that apply to this pen's type

Pen

public Pen()

Creates a blank pen, using the default values for all attributes that apply to this pen's type.

Pen

public Pen(Pen copy)

Method Detail

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

toDataset

public static Dataset toDataset(java.util.List<Pen> pens,
                                PenAttribute[] penAttributes,
                                PenType type)

Creates a dataset that represents the given list. All pens must be of the same type

getType

public abstract PenType getType()

getDataGrouping

public abstract IPenDatasourceFactory getDataGrouping(java.util.Set<java.lang.String> dynamicGroups)

An object that is hashable and unique to any parameters required to pull the data for this pen

Parameters:

dynamicGroups - The names of all configured dynamic groups.

getName

public java.lang.String getName()

getGroupAndName

public java.lang.String getGroupAndName()

Returns the pen's group and name together as "Group\Name" or just "Name" if the group is blank.

getInt

public int getInt(PenAttribute attr)

getSortOrder

public java.lang.Integer getSortOrder()

getFloat

public float getFloat(PenAttribute attr)

getString

public java.lang.String getString(PenAttribute attr)

getColor

public java.awt.Color getColor(PenAttribute attr)

getBoolean

public boolean getBoolean(PenAttribute attr)

set

public void set(PenAttribute attr,
                java.lang.Object value)

get

public java.lang.Object get(PenAttribute attr)

compareTo

public int compareTo(Pen o)

Specified by:

compareTo in interface java.lang.Comparable<Pen>