com.goldencode.p2j.ui

Class WordWrapElement

java.lang.Object

com.goldencode.p2j.ui.FrameElement

com.goldencode.p2j.ui.Element

com.goldencode.p2j.ui.WordWrapElement

All Implemented Interfaces:

Accessor

public class WordWrapElement
extends Element

This class marks a specific widget as needing word wrap for the current editing operation.

Each such element has a group index (by default this is 0). All elements with the same group index are part of the same word wrapping group.

Field Summary

Fields

Modifier and Type	Field and Description
private int	idx Group index.
private boolean	widgetOnly Is this a widget-only element?

Constructor Summary

Constructors

Constructor and Description
WordWrapElement(Accessor data, GenericWidget widget) Create an instance with a group index of 0.
WordWrapElement(Accessor data, GenericWidget widget, int idx) Create an instance with the specified group index.
WordWrapElement(Accessor data, java.lang.String fmt, GenericWidget widget) Create an instance with a group index of 0.
WordWrapElement(Accessor data, java.lang.String fmt, GenericWidget widget, int idx) Create an instance with the specified group index.
WordWrapElement(BaseDataType data, GenericWidget widget) Create an instance with a group index of 0.
WordWrapElement(BaseDataType data, GenericWidget widget, int idx) Create an instance with the specified group index.
WordWrapElement(BaseDataType data, java.lang.String fmt, GenericWidget widget) Create an instance with a group index of 0.
WordWrapElement(BaseDataType data, java.lang.String fmt, GenericWidget widget, int idx) Create an instance with the specified group index.
WordWrapElement(GenericWidget widget) Create a widget-only instance with a group index of 0.
WordWrapElement(GenericWidget widget, int idx) Create a widget-only instance with a given group index.

Method Summary

Modifier and Type	Method and Description
int	getIndex() Accesses the group index.
boolean	widgetOnly() Determines if the element represents a widget with no data (like a button).
boolean	wordWrap() Determines if the element should cause word wrap to be activated during editing operations.

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

get, getDataAccessor, getFormat, getFormattedValue, getWidget, hasFormat, set

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

assignOnly, bypass, getAccumulator, statsColumn

Methods inherited from class java.lang.Object

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

Field Detail

idx

private int idx

Group index.

widgetOnly

private boolean widgetOnly

Is this a widget-only element?

Constructor Detail

WordWrapElement

public WordWrapElement(GenericWidget widget)

Create a widget-only instance with a group index of 0.

Parameters:

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

WordWrapElement

public WordWrapElement(GenericWidget widget,
                       int idx)

Create a widget-only instance with a given group index.

Parameters:

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

idx - Group index.

WordWrapElement

public WordWrapElement(Accessor data,
                       GenericWidget widget)

Create an instance with a group index of 0.

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.

WordWrapElement

public WordWrapElement(BaseDataType data,
                       GenericWidget widget)

Create an instance with a group index of 0.

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.

WordWrapElement

public WordWrapElement(Accessor data,
                       GenericWidget widget,
                       int idx)

Create an instance with the specified group index.

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.

idx - Group index.

WordWrapElement

public WordWrapElement(BaseDataType data,
                       GenericWidget widget,
                       int idx)

Create an instance with the specified group index.

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.

idx - Group index.

WordWrapElement

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

Create an instance with a group index of 0.

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.

WordWrapElement

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

Create an instance with a group index of 0.

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.

WordWrapElement

public WordWrapElement(Accessor data,
                       java.lang.String fmt,
                       GenericWidget widget,
                       int idx)

Create an instance with the specified group index.

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.

idx - Group index.

WordWrapElement

public WordWrapElement(BaseDataType data,
                       java.lang.String fmt,
                       GenericWidget widget,
                       int idx)

Create an instance with the specified group index.

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.

idx - Group index.

Method Detail

wordWrap

public boolean wordWrap()

Determines if the element should cause word wrap to be activated during editing operations.

Overrides:

wordWrap in class FrameElement

Returns:

Always true;

getIndex

public int getIndex()

Accesses the group index.

Returns:

The group index.

widgetOnly

public boolean widgetOnly()

Determines if the element represents a widget with no data (like a button).

Overrides:

widgetOnly in class FrameElement

Returns:

true if this widget has no data or is being used without its data properties.