se.entra.phantom.server

Class ApplicationReferences

java.lang.Object

se.entra.phantom.server.ApplicationReferences

public class ApplicationReferences
extends Object

The application references class used to find references in the application.

Below, the Owner Object is one of the classes PhantomApplicationData, PhantomPanelData, PhantomCBar, PhantomControl, PhantomMessageBox, PhantomMenu, PhantomPopupMenu, or PhantomMenuItem.

Author:

Christopher Mindus

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	ApplicationReferences.BarFileReference Class holding a BarFileReference.
class	ApplicationReferences.BaseReference Class used to hold owner, container and perhaps the panel.
class	ApplicationReferences.ComboFileReference Class holding a ComboFileReference.
class	ApplicationReferences.ControlReference Class holding a ControlReference.
class	ApplicationReferences.HostFieldReference Class holding a HostFieldReference.
class	ApplicationReferences.HostScreenReference Class holding a HostScreenReference.
static interface	ApplicationReferences.IHostReference Interface for Host Screen/Field reference.
class	ApplicationReferences.ImageReference Class holding a ImageReference.
class	ApplicationReferences.ObjectReference Class holding a ObjectReference.
class	ApplicationReferences.PanelReference Class holding a PanelReference.
class	ApplicationReferences.TextIDReference Class holding a text ID reference.

Field Summary

Fields

Modifier and Type	Field and Description
LinkedHashMap<String,ApplicationReferences.BarFileReference>	bars Bar file references.
LinkedHashMap<String,ApplicationReferences.ComboFileReference>	cmbs Combobox file references.
LinkedHashMap<String,ApplicationReferences.ControlReference>	controls Control references.
LinkedHashMap<String,ApplicationReferences.HostFieldReference>	hostFields Host field references.
LinkedHashMap<String,ApplicationReferences.HostScreenReference>	hostScreens Host screen references.
LinkedHashMap<String,ApplicationReferences.ImageReference>	images Image references.
LinkedHashMap<String,ApplicationReferences.ObjectReference>	objects Object references.
LinkedHashMap<String,ApplicationReferences.PanelReference>	panels Panel references.
LinkedHashMap<String,ApplicationReferences.TextIDReference>	textIDs Text ID references.

Method Summary

Modifier and Type	Method and Description
void	addBarFileReference(Object owner, String fileName, String location) Adds a reference to a Bar File.
void	addComboBoxFileReference(Object owner, String fileName, String location) Adds a reference to a Combobox File.
void	addControlReference(Object container, Object owner, String controlID, String location) Adds a reference to a Control.
void	addControlReference(Object owner, String controlID, String location) Adds a reference to a Control.
void	addHostFieldReference(Object container, Object owner, String hostField, String location) Adds a reference from a Control/Menu item or Panel to a Host Field.
void	addHostFieldReference(Object owner, String hostField, String location) Adds a reference from a Control/Menu item or Panel to a Host Field.
void	addHostScreenReference(Object owner, String screen, String location) Adds a reference to a host screen (from hidden panel).
void	addImageReference(Object owner, String image, String location) Adds a reference to an Image.
void	addImageReference(PhantomControl pc, String text, int bitmapFlags, String location) Processes a text string for the push button, check box and radio button for images.
void	addObjectReference(Object container, Object owner, String objectID, String location) Adds a reference from a Control to an Object.
void	addObjectReference(Object owner, String objectID, String location) Adds a reference from a Control to an Object.
void	addPanelReference(Object container, Object owner, String panelID, String location) Adds a reference to a Panel.
void	addPanelReference(Object owner, String panelID, String location) Adds a reference to a Panel.
void	addTextIDReference(Object container, Object owner, String textID, String location) Adds a reference to a Text ID.
void	addTextIDReference(Object owner, String textID, String location) Adds a reference to a Text ID.
StringBuilder	getAll() Gets the list the unresolved items for the application.
void	getImageRefs(String fileName, ArrayList<ENPObject> objs) Gets references for an image file name, consisting of either full file name or path_to_jar + " | " + image_path.
void	getImageRefs(String fileName, String info, ArrayList<ENPObject> objs) Gets references for an image file name, consisting of either full file name or path_to_jar + " | " + image_path.
ArrayList<ENPObject>	getNPReferences(int type, String id, String info) References request from Eclipse.
String[]	getReferencedComboBoxFiles() Gets a list of all combobox files referenced in the application.
String[]	getReferencedImages() Gets the list of referenced images.
StringBuilder	getUnresolved() Gets the list the unresolved items for the application.
StringBuilder	getUnresolvedList(boolean doIncludeImages) Gets the list the unresolved items for the application.
void	updateReferences(PhantomApplicationData appData) Updates all references when the Application Data has been updated.
void	updateReferences(PhantomCBar bar) Updates all references for a Bar file when it has been updated.
void	updateReferences(PhantomPanelData panel) Updates all references for a Panel that has been reloaded.
void	updateReferences(PhantomPopupMenu popupMenu) Updates all references for a Popup menu that has been reloaded.

Methods inherited from class java.lang.Object

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

Field Detail

textIDs

public final LinkedHashMap<String,ApplicationReferences.TextIDReference> textIDs

Text ID references.

objects

public final LinkedHashMap<String,ApplicationReferences.ObjectReference> objects

Object references.

panels

public final LinkedHashMap<String,ApplicationReferences.PanelReference> panels

Panel references.

controls

public final LinkedHashMap<String,ApplicationReferences.ControlReference> controls

Control references.

hostScreens

public final LinkedHashMap<String,ApplicationReferences.HostScreenReference> hostScreens

Host screen references.

hostFields

public final LinkedHashMap<String,ApplicationReferences.HostFieldReference> hostFields

Host field references.

bars

public final LinkedHashMap<String,ApplicationReferences.BarFileReference> bars

Bar file references.

cmbs

public final LinkedHashMap<String,ApplicationReferences.ComboFileReference> cmbs

Combobox file references.

images

public final LinkedHashMap<String,ApplicationReferences.ImageReference> images

Image references.

Method Detail

addHostScreenReference

public void addHostScreenReference(Object owner,
                                   String screen,
                                   String location)

Adds a reference to a host screen (from hidden panel).

Parameters:

owner - The owner.

screen - The host screen.

location - Description of reference location, null for default.

addHostFieldReference

public void addHostFieldReference(Object owner,
                                  String hostField,
                                  String location)

Adds a reference from a Control/Menu item or Panel to a Host Field.

Parameters:

owner - The owner.

hostField - The host field name.

location - Description of reference location, null for default.

addHostFieldReference

public void addHostFieldReference(Object container,
                                  Object owner,
                                  String hostField,
                                  String location)

Adds a reference from a Control/Menu item or Panel to a Host Field.

Parameters:

owner - The owner.

hostField - The host field name.

location - Description of reference location, null for default.

addObjectReference

public void addObjectReference(Object owner,
                               String objectID,
                               String location)

Adds a reference from a Control to an Object.

Parameters:

owner - The owner.

objectID - The Object name.

location - Description of reference location, null for default.

addObjectReference

public void addObjectReference(Object container,
                               Object owner,
                               String objectID,
                               String location)

Adds a reference from a Control to an Object.

Parameters:

container - The container.

owner - The owner.

objectID - The Object ID.

location - Description of reference location, null for default.

addControlReference

public void addControlReference(Object owner,
                                String controlID,
                                String location)

Adds a reference to a Control.

Parameters:

owner - The owner.

controlID - The control ID.

location - Description of reference location, null for default.

addControlReference

public void addControlReference(Object container,
                                Object owner,
                                String controlID,
                                String location)

Adds a reference to a Control.

Parameters:

owner - The owner.

controlID - The control ID.

location - Description of reference location, null for default.

addPanelReference

public void addPanelReference(Object owner,
                              String panelID,
                              String location)

Adds a reference to a Panel.

Parameters:

owner - The owner.

panelID - The panel ID.

location - Description of reference location, null for default.

addPanelReference

public void addPanelReference(Object container,
                              Object owner,
                              String panelID,
                              String location)

Adds a reference to a Panel.

Parameters:

owner - The owner.

panelID - The panel ID.

location - Description of reference location, null for default.

addTextIDReference

public void addTextIDReference(Object owner,
                               String textID,
                               String location)

Adds a reference to a Text ID.

Parameters:

owner - The owner.

textID - The text ID.

location - Description of reference location, null for default.

addTextIDReference

public void addTextIDReference(Object container,
                               Object owner,
                               String textID,
                               String location)

Adds a reference to a Text ID.

Parameters:

owner - The owner.

textID - The text ID.

location - Description of reference location, null for default.

addImageReference

public void addImageReference(Object owner,
                              String image,
                              String location)

Adds a reference to an Image.

Parameters:

owner - The owner.

image - The image name.

location - Description of reference location, null for default.

addImageReference

public void addImageReference(PhantomControl pc,
                              String text,
                              int bitmapFlags,
                              String location)

Processes a text string for the push button, check box and radio button for images.

addBarFileReference

public void addBarFileReference(Object owner,
                                String fileName,
                                String location)

Adds a reference to a Bar File.

Parameters:

owner - The owner.

fileName - The Bar file name.

location - Description of reference location, null for default.

addComboBoxFileReference

public void addComboBoxFileReference(Object owner,
                                     String fileName,
                                     String location)

Adds a reference to a Combobox File.

Parameters:

owner - The owner.

fileName - The CMB file name.

location - Description of reference location, null for default.

updateReferences

public void updateReferences(PhantomPanelData panel)

Updates all references for a Panel that has been reloaded.

updateReferences

public void updateReferences(PhantomPopupMenu popupMenu)

Updates all references for a Popup menu that has been reloaded.

updateReferences

public void updateReferences(PhantomApplicationData appData)

Updates all references when the Application Data has been updated.

updateReferences

public void updateReferences(PhantomCBar bar)

Updates all references for a Bar file when it has been updated.

getUnresolvedList

public StringBuilder getUnresolvedList(boolean doIncludeImages)

Gets the list the unresolved items for the application.

Returns:

The unresolved list in textual form, null for no errors.

getUnresolved

public StringBuilder getUnresolved()

Gets the list the unresolved items for the application.

Returns:

The unresolved list in textual form, null for no errors.

getAll

public StringBuilder getAll()

Gets the list the unresolved items for the application.

Returns:

The unresolved list in textual form, null for no errors.

getNPReferences

public ArrayList<ENPObject> getNPReferences(int type,
                                            String id,
                                            String info)

References request from Eclipse.

Parameters:

type - The type of request, INetPhantomEclipseConstants.TYPE_*.

id - ID if possible of the requestor.

info - If no ID, then index, originating from Editor index.

Returns:

Found references.

getImageRefs

public void getImageRefs(String fileName,
                         ArrayList<ENPObject> objs)

Gets references for an image file name, consisting of either full file name or path_to_jar + " | " + image_path.

Parameters:

fileName - The image to look-up.

objs - References returned in this array.

getImageRefs

public void getImageRefs(String fileName,
                         String info,
                         ArrayList<ENPObject> objs)

Gets references for an image file name, consisting of either full file name or path_to_jar + " | " + image_path.

Parameters:

fileName - The image to look-up.

objs - References returned in this array.

getReferencedComboBoxFiles

public String[] getReferencedComboBoxFiles()

Gets a list of all combobox files referenced in the application.

getReferencedImages

public String[] getReferencedImages()

Gets the list of referenced images.