com.goldencode.p2j.ui

Class Element

java.lang.Object

com.goldencode.p2j.ui.FrameElement

com.goldencode.p2j.ui.Element

All Implemented Interfaces:

Accessor

Direct Known Subclasses:

AggregatorElement, WordWrapElement

public class Element
extends FrameElement

This class provides a simple association between a widget and the source and/or sink for the data to be displayed/edited in that widget.

Field Summary

Fields

Modifier and Type	Field and Description
private Accessor	data The source and/or sink of the widget's data.
private java.lang.String	fmt The value's associated format string or null.
private GenericWidget	widget The widget associated with this element.

Constructor Summary

Constructors

Constructor and Description
Element(Accessor data, GenericWidget widget) Create an instance.
Element(Accessor data, java.lang.String fmt, GenericWidget widget) Create an instance.
Element(BaseDataType data, GenericWidget widget) Create an instance.
Element(BaseDataType data, java.lang.String fmt, GenericWidget widget) Create an instance.
Element(boolean data, GenericWidget widget) Create an instance.
Element(boolean data, java.lang.String fmt, GenericWidget widget) Create an instance.
Element(double data, GenericWidget widget) Create an instance.
Element(double data, java.lang.String fmt, GenericWidget widget) Create an instance.
Element(GenericWidget widget) Create an instance associated only with a widget.
Element(int data, GenericWidget widget) Create an instance.
Element(int data, java.lang.String fmt, GenericWidget widget) Create an instance.
Element(java.lang.String data, GenericWidget widget) Create an instance.
Element(java.lang.String data, java.lang.String fmt, GenericWidget widget) Create an instance.

Method Summary

Modifier and Type	Method and Description
BaseDataType	get() Get a copy of the referenced object's current runtime value (this does not return the original instance itself).
Accessor	getDataAccessor() Returns the source and/or sink of the widget's data.
java.lang.String	getFormat() Accesses the format string associated with this frame element.
FormattedValue	getFormattedValue() Accesses the formatted value associated with this frame element.
GenericWidget	getWidget() Accesses the widget associated with this frame element.
boolean	hasFormat() Determines if the element stores a format string in addition to a data value.
void	set(BaseDataType val) Set the referenced object's current runtime value to the given value.

Methods inherited from class com.goldencode.p2j.ui.FrameElement

assignOnly, bypass, getAccumulator, statsColumn, widgetOnly, wordWrap

Methods inherited from class java.lang.Object

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

Field Detail

data

private Accessor data

The source and/or sink of the widget's data.

widget

private GenericWidget widget

The widget associated with this element.

fmt

private java.lang.String fmt

The value's associated format string or null.

Constructor Detail

Element

public Element(GenericWidget widget)

Create an instance associated only with a widget. This is used by PROMPT-FOR statement.

Parameters:

widget - The widget instance representing the exact frame field and state of that field. Must NOT be null.

Element

public Element(Accessor data,
               GenericWidget widget)

Create an instance.

Parameters:

data - The data to display/edit in the given widget. Must NOT be null.

widget - The widget instance representing the exact frame field and state of that field. Must NOT be null.

Element

public Element(BaseDataType data,
               GenericWidget widget)

Create an instance.

Parameters:

data - The data to display/edit in the given widget. Must NOT be null.

widget - The widget instance representing the exact frame field and state of that field. Must NOT be null.

Element

public Element(java.lang.String data,
               GenericWidget widget)

Create an instance.

WARNING: this form of the constructor allows primative (non-wrapper) types to be copied to the screen buffer BUT any assignment back to such widgets will silently fail since there is no backing wrapper instance in the calling code to which to assign.

Parameters:

data - The data to display/edit in the given widget. Must NOT be null.

widget - The widget instance representing the exact frame field and state of that field. Must NOT be null.

Element

public Element(int data,
               GenericWidget widget)

Create an instance.

WARNING: this form of the constructor allows primative (non-wrapper) types to be copied to the screen buffer BUT any assignment back to such widgets will silently fail since there is no backing wrapper instance in the calling code to which to assign.

Parameters:

data - The data to display/edit in the given widget.

widget - The widget instance representing the exact frame field and state of that field. Must NOT be null.

Element

public Element(double data,
               GenericWidget widget)

Create an instance.

WARNING: this form of the constructor allows primative (non-wrapper) types to be copied to the screen buffer BUT any assignment back to such widgets will silently fail since there is no backing wrapper instance in the calling code to which to assign.

Parameters:

data - The data to display/edit in the given widget.

widget - The widget instance representing the exact frame field and state of that field. Must NOT be null.

Element

public Element(boolean data,
               GenericWidget widget)

Create an instance.

WARNING: this form of the constructor allows primative (non-wrapper) types to be copied to the screen buffer BUT any assignment back to such widgets will silently fail since there is no backing wrapper instance in the calling code to which to assign.

Parameters:

data - The data to display/edit in the given widget.

widget - The widget instance representing the exact frame field and state of that field. Must NOT be null.

Element

public Element(Accessor data,
               java.lang.String fmt,
               GenericWidget widget)

Create an instance.

Parameters:

data - The data to display/edit in the given widget. Must NOT be null.

fmt - The format string to associate with the data value. May be null.

widget - The widget instance representing the exact frame field and state of that field. Must NOT be null.

Element

public Element(BaseDataType data,
               java.lang.String fmt,
               GenericWidget widget)

Create an instance.

Parameters:

data - The data to display/edit in the given widget. Must NOT be null.

fmt - The format string to associate with the data value. May be null.

widget - The widget instance representing the exact frame field and state of that field. Must NOT be null.

Element

public Element(java.lang.String data,
               java.lang.String fmt,
               GenericWidget widget)

Create an instance.

WARNING: this form of the constructor allows primative (non-wrapper) types to be copied to the screen buffer BUT any assignment back to such widgets will silently fail since there is no backing wrapper instance in the calling code to which to assign.

Parameters:

data - The data to display/edit in the given widget. Must NOT be null.

fmt - The format string to associate with the data value. May be null.

widget - The widget instance representing the exact frame field and state of that field. Must NOT be null.

Element

public Element(int data,
               java.lang.String fmt,
               GenericWidget widget)

Create an instance.

WARNING: this form of the constructor allows primative (non-wrapper) types to be copied to the screen buffer BUT any assignment back to such widgets will silently fail since there is no backing wrapper instance in the calling code to which to assign.

Parameters:

data - The data to display/edit in the given widget.

fmt - The format string to associate with the data value. May be null.

widget - The widget instance representing the exact frame field and state of that field. Must NOT be null.

Element

public Element(double data,
               java.lang.String fmt,
               GenericWidget widget)

Create an instance.

WARNING: this form of the constructor allows primative (non-wrapper) types to be copied to the screen buffer BUT any assignment back to such widgets will silently fail since there is no backing wrapper instance in the calling code to which to assign.

Parameters:

data - The data to display/edit in the given widget.

fmt - The format string to associate with the data value. May be null.

widget - The widget instance representing the exact frame field and state of that field. Must NOT be null.

Element

public Element(boolean data,
               java.lang.String fmt,
               GenericWidget widget)

Create an instance.

WARNING: this form of the constructor allows primative (non-wrapper) types to be copied to the screen buffer BUT any assignment back to such widgets will silently fail since there is no backing wrapper instance in the calling code to which to assign.

Parameters:

data - The data to display/edit in the given widget.

fmt - The format string to associate with the data value. May be null.

widget - The widget instance representing the exact frame field and state of that field. Must NOT be null.

Method Detail

hasFormat

public boolean hasFormat()

Determines if the element stores a format string in addition to a data value.

Overrides:

hasFormat in class FrameElement

Returns:

true if there is a format string encoded in this instance, false if the format string is null.

getFormattedValue

public FormattedValue getFormattedValue()

Accesses the formatted value associated with this frame element.

Overrides:

getFormattedValue in class FrameElement

Returns:

The formatted value.

getFormat

public java.lang.String getFormat()

Accesses the format string associated with this frame element.

Overrides:

getFormat in class FrameElement

Returns:

The format string.

getWidget

public GenericWidget getWidget()

Accesses the widget associated with this frame element.

Overrides:

getWidget in class FrameElement

Returns:

The widget.

get

public BaseDataType get()

Get a copy of the referenced object's current runtime value (this does not return the original instance itself).

Returns:

The copy of the current value.

set

public void set(BaseDataType val)

Set the referenced object's current runtime value to the given value.

Parameters:

val - The current value to be assigned into the referenced object.

getDataAccessor

public Accessor getDataAccessor()

Returns the source and/or sink of the widget's data.

Returns:

See above.