org.lsst.ccs.gconsole.plugins.monitor

Class FormattedValue

java.lang.Object

org.lsst.ccs.gconsole.plugins.monitor.FormattedValue

public class FormattedValue
extends Object

Formatted content of a graphic component that displays a single value. The value may correspond to any MonitorField.

Author:

onoprien

Field Summary

Fields

Modifier and Type	Field and Description
Color	bgColor
Consumer<MonitorCell>	click1
Boolean	editable
static FormattedValue	EMPTY Indicates a permanently empty cell.
Color	fgColor
String	format
Integer	horizontalAlignment
static FormattedValue	NA Indicates that the data is currently unavailable.
String	text
String	toolTip
Object	value

Constructor Summary

Constructors

Constructor and Description
FormattedValue() Default constructor.
FormattedValue(FormattedValue other) Copy constructor.
FormattedValue(String text, Color fgColor, Color bgColor, Integer horizontalAlignment, String toolTip, Boolean isEditable) Full constructor.
FormattedValue(String text, Integer horizontalAlignment) Constructs an instance with specified text and alignment.

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj)
Color	getBgColor()
Consumer<MonitorCell>	getClick1()
Color	getFgColor()
int	getHorizontalAlignment()
String	getText()
String	getToolTip()
int	hashCode()
boolean	isEditable() Deprecated.
boolean	isValid() Returns true if no additional formatting is required before this formatted value can be displayed.
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

NA

public static final FormattedValue NA

Indicates that the data is currently unavailable.

EMPTY

public static final FormattedValue EMPTY

Indicates a permanently empty cell.

text

public String text

fgColor

public Color fgColor

bgColor

public Color bgColor

horizontalAlignment

public Integer horizontalAlignment

toolTip

public String toolTip

editable

public Boolean editable

click1

public Consumer<MonitorCell> click1

value

public Object value

format

public String format

Constructor Detail

FormattedValue

public FormattedValue()

Default constructor. All fields are null.

FormattedValue

public FormattedValue(String text,
                      Color fgColor,
                      Color bgColor,
                      Integer horizontalAlignment,
                      String toolTip,
                      Boolean isEditable)

Full constructor. All fields are set to specified values.

Parameters:

text - Text to be displayed.

fgColor - Text color.

bgColor - Background color.

horizontalAlignment - Horizontal alignment, as defined in SwingConstants.

toolTip - Tool tip.

isEditable - True if the cell should be editable by the console user.

FormattedValue

public FormattedValue(FormattedValue other)

Copy constructor.

Parameters:

other - Instance to be copied.

FormattedValue

public FormattedValue(String text,
                      Integer horizontalAlignment)

Constructs an instance with specified text and alignment. All other fields are left at default values.

Parameters:

text - Text to be displayed.

horizontalAlignment - Horizontal alignment, as defined in SwingConstants.

Method Detail

isValid

public boolean isValid()

Returns true if no additional formatting is required before this formatted value can be displayed.

Returns:

True if this value is ready to be displayed.

getText

public String getText()

getFgColor

public Color getFgColor()

getBgColor

public Color getBgColor()

getHorizontalAlignment

public int getHorizontalAlignment()

getToolTip

public String getToolTip()

isEditable

@Deprecated
public boolean isEditable()

Deprecated.

getClick1

public Consumer<MonitorCell> getClick1()

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object