Package com.inductiveautomation.rm.shape

Class LabelFormat

java.lang.Object

com.inductiveautomation.rm.shape.LabelFormat

All Implemented Interfaces:

java.lang.Comparable<LabelFormat>

public class LabelFormat
extends java.lang.Object
implements java.lang.Comparable<LabelFormat>

Filename: LabelFormat Author: Perry Arellano-Jones Created on: 7/27/15 Project: ignition_dev_7_8B A shared class that holds the size information about the format of a RMLabel.

Field Summary

Fields

Modifier and Type	Field	Description
double	bottomMargin
int	colCount
static java.util.Map<java.lang.String,LabelFormat>	formatMap
java.lang.String	formatName
double	labelHeight
double	labelWidth
double	leftMargin
double	pageHeight
double	pageWidth
double	rightMargin
int	rowCount
double	spacingX
double	spacingY
double	topMargin

Constructor Summary

Constructors

Constructor	Description
LabelFormat()
LabelFormat(RMLabels label)
LabelFormat(java.lang.String name, double labelWidth, double labelHeight, double spacingWidth, double spacingHeight, int rows, int cols, double width, double height)
LabelFormat(java.lang.String name, double width, double height, double spacingWidth, double spacingHeight, int rows, int cols, double pageWidth, double pageHeight, double topMargin, double leftMargin, double bottomMargin, double rightMargin)	Creates a new label format.

Method Summary

Modifier and Type	Method	Description
int	compareTo(LabelFormat format)
static java.util.Map<java.lang.String,LabelFormat>	getFormatMap()
static LabelFormat	getLabelFormat(java.lang.String formatName)
java.lang.String	toString()	Returns string representation of label format (the format name).

Methods inherited from class java.lang.Object

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

Field Detail

formatMap

public static final java.util.Map<java.lang.String,LabelFormat> formatMap

labelWidth

public double labelWidth

labelHeight

public double labelHeight

spacingX

public double spacingX

spacingY

public double spacingY

pageWidth

public double pageWidth

pageHeight

public double pageHeight

topMargin

public double topMargin

leftMargin

public double leftMargin

bottomMargin

public double bottomMargin

rightMargin

public double rightMargin

rowCount

public int rowCount

colCount

public int colCount

formatName

public java.lang.String formatName

Constructor Detail

LabelFormat

public LabelFormat(java.lang.String name,
                   double width,
                   double height,
                   double spacingWidth,
                   double spacingHeight,
                   int rows,
                   int cols,
                   double pageWidth,
                   double pageHeight,
                   double topMargin,
                   double leftMargin,
                   double bottomMargin,
                   double rightMargin)

Creates a new label format.

LabelFormat

public LabelFormat()

LabelFormat

public LabelFormat(RMLabels label)

LabelFormat

public LabelFormat(java.lang.String name,
                   double labelWidth,
                   double labelHeight,
                   double spacingWidth,
                   double spacingHeight,
                   int rows,
                   int cols,
                   double width,
                   double height)

Method Detail

toString

public java.lang.String toString()

Returns string representation of label format (the format name).

Overrides:

toString in class java.lang.Object

getFormatMap

public static java.util.Map<java.lang.String,LabelFormat> getFormatMap()

getLabelFormat

public static LabelFormat getLabelFormat(java.lang.String formatName)

compareTo

public int compareTo(LabelFormat format)

Specified by:

compareTo in interface java.lang.Comparable<LabelFormat>