com.goldencode.p2j.ui

Class WidgetDownId

java.lang.Object

com.goldencode.p2j.ui.WidgetId

com.goldencode.p2j.ui.WidgetDownId

All Implemented Interfaces:

java.io.Externalizable, java.io.Serializable, java.lang.Comparable<WidgetId>

public class WidgetDownId
extends WidgetId

This class represents widget identifiers for a widget part of a frame's down body.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
private int	downIdx The location of the widget associated with this ID in the frame's down body.

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

_DEFAULT_WINDOW_ID, DEFAULT_WINDOW_ID, INPUT_FRAME_ID, INVALID_WIDGET_ID, VIRTUAL_WIDGET_ID_RANGE_BEGIN, WIDGET_ID_RANGE_BEGIN

Constructor Summary

Constructors

Constructor and Description
WidgetDownId() Default c'tor.
WidgetDownId(int id, int downIdx) Create a new widget ID which is linked to a widget located on the given row, in the frame's down body.

Method Summary

Modifier and Type	Method and Description
int	compareTo(WidgetId wid) Compare this instance with the given object.
WidgetId	createId(int widgetId) Create a new WidgetDownId instance which is assigned the given widgetId and inherits this id's downIdx.
boolean	equals(java.lang.Object obj) Check if the given object is the same as this one.
int	getDownIdx() Get the position in the frame's down body of this widget.
int	hashCode() Compute a hash code for this widget ID.
void	readExternal(java.io.ObjectInput in) Replacement for the default object reading method.
java.lang.String	toString() Get a string representation of this ID.
void	writeExternal(java.io.ObjectOutput out) Replacement for the default object writing method.

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

asInt, createId, equals, match, nextID, virtualWidget, virtualWidget

Methods inherited from class java.lang.Object

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

Field Detail

downIdx

private int downIdx

The location of the widget associated with this ID in the frame's down body.

Constructor Detail

WidgetDownId

public WidgetDownId()

Default c'tor. Not for public use, for de-serialization only.

WidgetDownId

public WidgetDownId(int id,
                    int downIdx)

Create a new widget ID which is linked to a widget located on the given row, in the frame's down body.

Parameters:

id - The widget ID.

downIdx - The index in the frame's down body of the widget associated with this ID.

Method Detail

createId

public WidgetId createId(int widgetId)

Create a new WidgetDownId instance which is assigned the given widgetId and inherits this id's downIdx.

Overrides:

createId in class WidgetId

Parameters:

widgetId - The new widgetId.

Returns:

See above.

getDownIdx

public int getDownIdx()

Get the position in the frame's down body of this widget.

Returns:

the downIdx value.

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.

Specified by:

writeExternal in interface java.io.Externalizable

Overrides:

writeExternal in class WidgetId

Parameters:

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

Throws:

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

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.

Specified by:

readExternal in interface java.io.Externalizable

Overrides:

readExternal in class WidgetId

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.

equals

public boolean equals(java.lang.Object obj)

Check if the given object is the same as this one.

Overrides:

equals in class WidgetId

Parameters:

obj - The candidate.

Returns:

true if this instance represents the same widget ID as the given one.

hashCode

public int hashCode()

Compute a hash code for this widget ID.

Overrides:

hashCode in class WidgetId

Returns:

See above.

toString

public java.lang.String toString()

Get a string representation of this ID.

Overrides:

toString in class WidgetId

Returns:

See above.

compareTo

public int compareTo(WidgetId wid)

Compare this instance with the given object. Return value matches the Comparable.compareTo(T).

Specified by:

compareTo in interface java.lang.Comparable<WidgetId>

Overrides:

compareTo in class WidgetId

Parameters:

wid - The widget ID to compare against.

Returns:

See Comparable.compareTo(T).