se.entra.phantom.server.phed.project

Class ENPObject

java.lang.Object

se.entra.phantom.server.phed.project.ENPObject

All Implemented Interfaces:

IENPObjectOwner

Direct Known Subclasses:

ENPAppFileReference, ENPBarFileReference, ENPHiddenPanelReference, ENPHostFieldReference, ENPHostScreenReference, ENPImageReference, ENPObjectReference, ENPPanelReference, ENPPopupMenuReference, ENPRootObject, ENPTextIDReference

public class ENPObject
extends Object
implements IENPObjectOwner

The NP object is an object that can be streamed over a Transaction holding information about any NetPhantom part of the application that is displayed in Eclipse tree views (Explorer or References).

Author:

Christopher Mindus

Field Summary

Fields

Modifier and Type	Field and Description
static ENPObject[]	EMPTY Empty array.
protected String	extra Extra information.
String	id The identifier.
protected String	info Local info, used by the type (such as Screen name or Control Index).

Constructor Summary

Constructors

Constructor and Description
ENPObject(int type, String id) Creates a new Object with just the type and ID, no extra information or specific image.
ENPObject(int type, String id, String extra) Creates a new Object with just the type and ID, extra information and no specific image.

Method Summary

Modifier and Type	Method and Description
void	add(ENPObject child) Adds a child.
void	addBarFileReference(PhantomApplicationData appData, String barFile) Adds a text ID reference.
void	addControlReference(PhantomPanelData panel, String controlID) Creates a reference-type object for an control.
void	addHostFieldReference(PhantomHostData hostData, String screen, String hostField) Adds a host field reference.
void	addHostScreenReference(PhantomRuntime runtime, String screenName) Creates a reference-type object for an Object.
void	addImageReference(PhantomRuntime runtime, String image) Adds an image reference.
void	addObjectReference(PhantomApplicationData appData, String objectID) Creates a reference-type object for an Object.
void	addPanelReference(PhantomApplicationData appData, String panelID) Creates a reference-type object for an host screen.
void	addTextIDReference(PhantomApplicationData appData, String textID) Adds a text ID reference.
void	append(Transaction trans) Appends the object to a transaction.
void	appendSelectionInfo(Transaction trans) Appends just selection information about the object, for Explorer selection from Editor.
boolean	equals(Object o) Checks for equality.
String	getExtra() Gets the extra text.
String	getLocalInfo() Gets local info.
protected boolean	invalidateIfDifferent(String s1, String s2) Verifies two strings for difference (null too), if not equal, onENPObjectInvalidated is called.
boolean	isUnresolved() Checks if unresolved.
void	onENPObjectInvalidated() Invalidates the chain of objects up to the owner in order to get it sent to Eclipse.
void	resolve() Called to resolve, passed on to all children.
void	setExtra(String text) Sets the extra text string.
void	setFileReferrer(String file) Sets the file referrer for reference objects.
void	setImage(int index) Sets the image index to use, INetPhantomEclipseConstants.IMG_*.
void	setLocalInfo(String info) Sets local info.
void	setOwner(IENPObjectOwner owner) Sets the owner (once only).
void	setResolved(int type, String extra) Sets the Object as resolved with specified parameters.
void	setUnresolved() Sets unresolved, if change occurs, invalidates the owner tree upwards.
void	setUnresolved(boolean on) Sets unresolved, if change occurs, invalidates the owner tree upwards.
void	setUnresolved(boolean on, String extra) Sets unresolved and extra text, if change occurs, invalidates the owner tree upwards.
void	setUnresolved(int type, String extra) Sets unresolved state with extra info, invalidates the owner tree upwards if changed.

Methods inherited from class java.lang.Object

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

Field Detail

EMPTY

public static final ENPObject[] EMPTY

Empty array.

id

public final String id

The identifier.

extra

protected String extra

Extra information.

info

protected String info

Local info, used by the type (such as Screen name or Control Index).

Constructor Detail

ENPObject

public ENPObject(int type,
                 String id)

Creates a new Object with just the type and ID, no extra information or specific image.

ENPObject

public ENPObject(int type,
                 String id,
                 String extra)

Creates a new Object with just the type and ID, extra information and no specific image.

Method Detail

setFileReferrer

public void setFileReferrer(String file)

Sets the file referrer for reference objects.

invalidateIfDifferent

protected boolean invalidateIfDifferent(String s1,
                                        String s2)

Verifies two strings for difference (null too), if not equal, onENPObjectInvalidated is called.

Returns:

true=different, false=equal.

setOwner

public void setOwner(IENPObjectOwner owner)

Sets the owner (once only).

onENPObjectInvalidated

public void onENPObjectInvalidated()

Invalidates the chain of objects up to the owner in order to get it sent to Eclipse.

Specified by:

onENPObjectInvalidated in interface IENPObjectOwner

resolve

public void resolve()

Called to resolve, passed on to all children.

setResolved

public void setResolved(int type,
                        String extra)

Sets the Object as resolved with specified parameters. Changes invalidates the tree upwards.

setUnresolved

public void setUnresolved()

Sets unresolved, if change occurs, invalidates the owner tree upwards.

setUnresolved

public void setUnresolved(boolean on)

Sets unresolved, if change occurs, invalidates the owner tree upwards.

setUnresolved

public void setUnresolved(boolean on,
                          String extra)

Sets unresolved and extra text, if change occurs, invalidates the owner tree upwards.

setUnresolved

public void setUnresolved(int type,
                          String extra)

Sets unresolved state with extra info, invalidates the owner tree upwards if changed.

setImage

public void setImage(int index)

Sets the image index to use, INetPhantomEclipseConstants.IMG_*.

setExtra

public void setExtra(String text)

Sets the extra text string.

setLocalInfo

public void setLocalInfo(String info)

Sets local info.

getLocalInfo

public String getLocalInfo()

Gets local info.

add

public void add(ENPObject child)

Adds a child.

append

public void append(Transaction trans)

Appends the object to a transaction.

appendSelectionInfo

public void appendSelectionInfo(Transaction trans)

Appends just selection information about the object, for Explorer selection from Editor.

isUnresolved

public boolean isUnresolved()

Checks if unresolved.

getExtra

public String getExtra()

Gets the extra text.

addTextIDReference

public void addTextIDReference(PhantomApplicationData appData,
                               String textID)

Adds a text ID reference.

addHostScreenReference

public void addHostScreenReference(PhantomRuntime runtime,
                                   String screenName)

Creates a reference-type object for an Object.

addHostFieldReference

public void addHostFieldReference(PhantomHostData hostData,
                                  String screen,
                                  String hostField)

Adds a host field reference.

Parameters:

hostData - The host data.

screen - Screen name if available, null or empty for none.

hostField - The host field.

addPanelReference

public void addPanelReference(PhantomApplicationData appData,
                              String panelID)

Creates a reference-type object for an host screen.

addObjectReference

public void addObjectReference(PhantomApplicationData appData,
                               String objectID)

Creates a reference-type object for an Object.

addBarFileReference

public void addBarFileReference(PhantomApplicationData appData,
                                String barFile)

Adds a text ID reference.

addImageReference

public void addImageReference(PhantomRuntime runtime,
                              String image)

Adds an image reference.

addControlReference

public void addControlReference(PhantomPanelData panel,
                                String controlID)

Creates a reference-type object for an control.

equals

public boolean equals(Object o)

Checks for equality.

Overrides:

equals in class Object