com.goldencode.p2j.ui

Class ControlSetConfig

java.lang.Object

com.goldencode.p2j.ui.WidgetConfig

com.goldencode.p2j.ui.BaseConfig

com.goldencode.p2j.ui.ControlConfig

com.goldencode.p2j.ui.ControlSetConfig

All Implemented Interfaces:

java.io.Externalizable, java.io.Serializable

Direct Known Subclasses:

BrowseColumnConfig, ComboBoxConfig, RadioSetConfig, SelectionListConfig

public class ControlSetConfig
extends ControlConfig

This class holds the common attributes for all widgets which have a set of the control items inside.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
private static int	ATTR_MASK_HONOR_FORMAT Bitwise mask to mark HONOR FORMAT atribute usage.
private static int	ATTR_MASK_ITEMS_SET_WHEN_REALIZED Bitwise mask to mark ITEMS SET WHEN REALIZED atribute usage.
private static int	ATTR_MASK_SORT Bitwise mask to mark SORT atribute usage.
char	delimiter The character value to separate the items inside the item string.
java.lang.String	format The string representing the inner data format for the items.
boolean	honorFormat Tell widget that format should be honored.
int	itemId item id generator
ControlSetItem[]	items Array of items
boolean	itemsSetWhenRealized Value of the "realized' flag when items' type (pairs/labels) was set
double	listHeightChars The height of the list widget.
double	listWidthChars The width of the list widget.
java.lang.String	mousePointer MOUSE-POINTER attribute
ControlSetItem[]	newAddedItems Array of new added items
int	numItems number of items, -1 mean uninitialized
java.lang.Boolean	pairs Set to true if items defined as pairs, default value must be null to denote the pairs is undecided
private static long	serialVersionUID
boolean	sort true to force items to be sorted.

Fields inherited from class com.goldencode.p2j.ui.ControlConfig

attrSpace, autoResize, clabel, dataType, dropTarget, forceLabel, help, index, INVALID_SELECTION, label, labels, possibleSideLabel, selectionActive, selectionEnd, selectionStart, sideLabelId, unknownDataType, untranslatedLabel

Fields inherited from class com.goldencode.p2j.ui.BaseConfig

align, bgcolor, bgcolorRgb, captionFontSize, clientColumn, clientHeightChars, clientHeightPixels, clientRow, clientWidthChars, clientWidthPixels, clientX, clientY, column, dcolor, dynamic, fgcolor, fgcolorRgb, fixedHeight, fixedWidth, font, fontChanged, fontName, fontSize, fontStyle, frameColumnOffset, frameRowOffset, frameXOffset, frameYOffset, heightChars, heightPixels, initColumn, initHeightChars, initRow, initWidthChars, initX, initY, INV_COORD, locationChanged, movable, name, parentId, pfcolor, resizable, row, selected, sysbgcolor, sysfgcolor, systemParentId, tabStop, title, titleDColor, titleFont, tooltip, widgetPlaced, widthChars, widthPixels, x, y

Fields inherited from class com.goldencode.p2j.ui.WidgetConfig

cfgClass, contextHelpId, disableRedraw, enabled, frameDefValue, frameId, fromOCX, header, hidden, id, manualHightlight, menuKey, menuMouse, modified, popupMenuId, realized, selectable, state, visible, wasRealized, zorder

Constructor Summary

Constructors

Modifier	Constructor and Description
	ControlSetConfig() Default constructor (only used in de-serialization).
protected	ControlSetConfig(int id) Create a new config and associate it with the given widget.
protected	ControlSetConfig(WidgetId id) Create a new config and associate it with the given widget.

Method Summary

Modifier and Type	Method and Description
void	applyConfig(WidgetConfig config) Set new values from the provided configuration instance.
boolean	deleteFromControlSet(int idx) Delete item by index.
private void	init() Initialize this config.
void	readExternal(java.io.ObjectInput in) Replacement for the default object reading method.
void	writeExternal(java.io.ObjectOutput out) Replacement for the default object writing method.

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

setDynamicFormat

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

getConfigManager, getDynamicColumnLabel, getDynamicFormat, getDynamicHelp, getDynamicLabel, getDynamicUntranslatedLabel, markFieldsDirty, setDynamicHeader, setDynamicHelp, setDynamicLabel, setDynamicLabels, setDynamicUntranslatedLabel, toString

Methods inherited from class java.lang.Object

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

Field Detail

serialVersionUID

private static final long serialVersionUID

See Also:

Constant Field Values

delimiter

public char delimiter

The character value to separate the items inside the item string.

sort

public boolean sort

true to force items to be sorted.

format

public java.lang.String format

The string representing the inner data format for the items.

items

public ControlSetItem[] items

Array of items

newAddedItems

public ControlSetItem[] newAddedItems

Array of new added items

honorFormat

public boolean honorFormat

Tell widget that format should be honored.

itemsSetWhenRealized

public boolean itemsSetWhenRealized

Value of the "realized' flag when items' type (pairs/labels) was set

pairs

public java.lang.Boolean pairs

Set to true if items defined as pairs, default value must be null to denote the pairs is undecided

itemId

public int itemId

item id generator

listHeightChars

public double listHeightChars

The height of the list widget.

listWidthChars

public double listWidthChars

The width of the list widget.

mousePointer

public java.lang.String mousePointer

MOUSE-POINTER attribute

numItems

public int numItems

number of items, -1 mean uninitialized

ATTR_MASK_SORT

private static final int ATTR_MASK_SORT

Bitwise mask to mark SORT atribute usage.

See Also:

Constant Field Values

ATTR_MASK_HONOR_FORMAT

private static final int ATTR_MASK_HONOR_FORMAT

Bitwise mask to mark HONOR FORMAT atribute usage.

See Also:

Constant Field Values

ATTR_MASK_ITEMS_SET_WHEN_REALIZED

private static final int ATTR_MASK_ITEMS_SET_WHEN_REALIZED

Bitwise mask to mark ITEMS SET WHEN REALIZED atribute usage.

See Also:

Constant Field Values

Constructor Detail

ControlSetConfig

public ControlSetConfig()

Default constructor (only used in de-serialization).

ControlSetConfig

protected ControlSetConfig(int id)

Create a new config and associate it with the given widget.

Parameters:

id - The ID of the widget to which this configuration belongs.

ControlSetConfig

protected ControlSetConfig(WidgetId id)

Create a new config and associate it with the given widget.

Parameters:

id - The ID of the widget to which this configuration belongs.

Method Detail

applyConfig

public void applyConfig(WidgetConfig config)

Set new values from the provided configuration instance.

Overrides:

applyConfig in class ControlConfig

Parameters:

config - The instance from which to take values.

deleteFromControlSet

public final boolean deleteFromControlSet(int idx)

Delete item by index.

Parameters:

idx - 1-based index of the item

Returns:

true if successful, return false if index is invalid.

readExternal

public void readExternal(java.io.ObjectInput in)
                  throws java.io.IOException,
                         java.lang.ClassNotFoundException

Replacement for the default object reading method. The latest state is read from the input source. The parent's state is read first.

Specified by:

readExternal in interface java.io.Externalizable

Overrides:

readExternal in class ControlConfig

Parameters:

in - The input source from which fields will be restored.

Throws:

java.io.IOException - In case of I/O errors.

java.lang.ClassNotFoundException - If payload can't be instantiated.

writeExternal

public void writeExternal(java.io.ObjectOutput out)
                   throws java.io.IOException

Replacement for the default object writing method. The latest state is written to the output destination. The parent's state is written first.

Specified by:

writeExternal in interface java.io.Externalizable

Overrides:

writeExternal in class ControlConfig

Parameters:

out - The output destination to which fields will be saved.

Throws:

java.io.IOException - In case of I/O errors.

init

private void init()

Initialize this config.