se.entra.phantom.server

Class PhantomCBusGraph

java.lang.Object

se.entra.phantom.server.PhantomControl

se.entra.phantom.server.PhantomCBusGraph

All Implemented Interfaces:

Cloneable, PhantomControlFlags, PhantomControlType

public class PhantomCBusGraph
extends PhantomControl

This class contains information about business graphics read from the Phantom Panel file.

Author:

Åsa Persson

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	PhantomCBusGraph.PhantomCBusGraphCategories --- Class PhantomCBusGraphCategories.
class	PhantomCBusGraph.PhantomCBusGraphLegend
class	PhantomCBusGraph.PhantomCBusGraphValueData Class PhantomCBusGraphValueData.
class	PhantomCBusGraph.PhantomCBusGraphValues --- Class PhantomCBusGraphValues.

Field Summary

Fields

Modifier and Type	Field and Description
PhantomCBusGraph.PhantomCBusGraphCategories	categoriesObject The Categories axis object.
static int	DEFAULT_FONT The default font (system proportional 10).
static int	FLAG_TYPE_BAR
static int	FLAG_TYPE_COLUMN
static int	FLAG_TYPE_DEFAULT Business graphics types.
static int	FLAG_TYPE_LINE
static int	FLAG_TYPE_PIE
static int	FLAG_TYPE_SPRAY
PhantomCBusGraph.PhantomCBusGraphLegend	legendObject The legend object containing legend information.
PhantomCBusGraphType	typeObject The specific type of business graph object.
PhantomCBusGraph.PhantomCBusGraphValues	valuesObject The Value axis object.

Fields inherited from class se.entra.phantom.server.PhantomControl

controlBase, controlColor, id, index, isBackgroundConverted, isForegroundConverted, object, panelData, popupMenu, tooltipText

Fields inherited from interface se.entra.phantom.server.PhantomControlType

CTRLTYPE_BUTTON, CTRLTYPE_CHECK, CTRLTYPE_COMBO, CTRLTYPE_FRAME, CTRLTYPE_GRAPH, CTRLTYPE_GROUP, CTRLTYPE_INOUT, CTRLTYPE_LIST, CTRLTYPE_MLE, CTRLTYPE_NOTE, CTRLTYPE_OUT, CTRLTYPE_RADIO, CTRLTYPE_RECT, CTRLTYPE_SPIN, CTRLTYPE_SUB, CTRLTYPE_TEXT, CTRLTYPE_TREE, CTRLTYPE_UNKNOWN, CTRLTYPE_USER, CTRLTYPES_COUNT, names

Fields inherited from interface se.entra.phantom.server.PhantomControlFlags

CTRLFLAG_MOVEX, CTRLFLAG_MOVEY, CTRLFLAG_NEWGROUP, CTRLFLAG_SIZEX, CTRLFLAG_SIZEY, CTRLFLAG_SUBWIN, CTRLFLAG_TABSTOP, CTRLFLAG_TRANSPARENT

Constructor Summary

Constructors

Constructor and Description
PhantomCBusGraph(PhantomFile data, PhantomPanelData panelData, int index, PhantomControlBase controlBase) Creates an instance of the control class.

Method Summary

Modifier and Type	Method and Description
protected void	addNPObjects(ENPObject obj) Gets the NPObject for the control.
static int	changeFont(int font, int newFont, boolean hasFontFace, boolean hasFontSize, boolean hasFontAttr) Changes a font according to the flags.
static int	encodeFont(int face, int size, int attributes) Encodes a font face, point size and attributes to a 16 bit UShort value.
protected boolean	equalsControl(PhantomControl c) Checks for control equality.
String	getControlObjectID() Needs override by the control if the object instance if not resolved in this class instance.
int	getDataSize(PhantomOutputFile outputFile) Get the size when saved to file.
protected String	getNPObjectExtra() Gets the "Extra" String for the NPObject.
boolean	isActionConnectedEnabled() Checks if a control is action connected to another.
void	rebind() Re-bind the panel data.
void	reloadObject() Reload object reference.
void	save(PhantomOutputFile file) Saves the instance of the control to file.
void	updateReferences(ApplicationReferences refs) Updates the Applications References instance.

Methods inherited from class se.entra.phantom.server.PhantomControl

addControlID, addControlReference, addHostFieldReference, appendBaseTransaction, checkTextPromptReferences, checkTextPromptReferences, clone, create, createNPObject, equals, getApplicationData, getBackgroundColor, getDesignerControl, getForegroundColor, getHostField, getHostFieldID, getID, getIndex, getNPObjectID, getObject, getObject, getPanelData, getReferencedFiles, getTypeDescription, getTypeDescriptionID, initializeDesignerControls, processColorConversion, processColorConversion, processColorConversion, processDisabledBackground, resolveComponentReferences, saveBase, setBackgroundColor, setForegroundColor, setIndex, updateGuiOnTheFlyValue

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_FONT

public static final int DEFAULT_FONT

The default font (system proportional 10).

FLAG_TYPE_DEFAULT

public static final int FLAG_TYPE_DEFAULT

Business graphics types.

See Also:

Constant Field Values

FLAG_TYPE_BAR

public static final int FLAG_TYPE_BAR

See Also:

Constant Field Values

FLAG_TYPE_COLUMN

public static final int FLAG_TYPE_COLUMN

See Also:

Constant Field Values

FLAG_TYPE_LINE

public static final int FLAG_TYPE_LINE

See Also:

Constant Field Values

FLAG_TYPE_PIE

public static final int FLAG_TYPE_PIE

See Also:

Constant Field Values

FLAG_TYPE_SPRAY

public static final int FLAG_TYPE_SPRAY

See Also:

Constant Field Values

typeObject

public PhantomCBusGraphType typeObject

The specific type of business graph object.

legendObject

public PhantomCBusGraph.PhantomCBusGraphLegend legendObject

The legend object containing legend information.

valuesObject

public PhantomCBusGraph.PhantomCBusGraphValues valuesObject

The Value axis object.

categoriesObject

public PhantomCBusGraph.PhantomCBusGraphCategories categoriesObject

The Categories axis object.

Constructor Detail

PhantomCBusGraph

public PhantomCBusGraph(PhantomFile data,
                        PhantomPanelData panelData,
                        int index,
                        PhantomControlBase controlBase)
                 throws IOException

Creates an instance of the control class. Loads the data from a Phantom Panel file that has previously been read into memory. BASE: + Type of business graphics SHORT + Base width SHORT + Pie sector angle SHORT + Field ID CHAR [HAS_IDLEN + 1] + Object name CHAR [HAS_FBLEN + 1] + Flag for legend BYTE + Stack values BYTE + Pie settings flag BYTE + Standard colour BYTE + Standard font SHORT + Line diagram tick marks BYTE + List separator BYTE + Thousand separator BYTE + Decimal separator BYTE + 44 reserved BYTE [44] + 100 percent BYTE + Flag for border use BYTE + Legend alignment BYTE + Legend border BYTE + Legend standard colour BYTE + Legend standard font SHORT TEXTS: + Head standard colour BYTE + Head standard font SHORT + Value standard colour BYTE + Value standard font SHORT + Category standard colour BYTE + Category standard font SHORT + Lead text for heading CHAR [HAS_MAXFLDLEADLEN + 1] + Lead text for Value axis CHAR [HAS_MAXFLDLEADLEN + 1] + Lead text for Category axis CHAR [HAS_MAXFLDLEADLEN + 1] + Lead text reserved 1 CHAR [HAS_MAXFLDLEADLEN + 1] + Lead text reserved 2 CHAR [HAS_MAXFLDLEADLEN + 1] + Lead text reserved 3 CHAR [HAS_MAXFLDLEADLEN + 1] CATEGORIES: + Flag to draw Category axis BYTE + Flag to draw major lines BYTE + Category data CHAR [HAS_GRAPH_CATEGDATALEN + 1] + Connected field name CHAR [HAS_IDLEN + 1] + Categories tick type BYTE + Placement of categories BYTE + Categories mark interval SHORT + Categories interval SHORT + Categories crossing SHORT + Value cross middle BYTE + Category data colour BYTE + Category data font SHORT + 61 reserved BYTE [61] VALUES: + Flag to draw Value axis BYTE + Auto min value BYTE + Auto max value BYTE + Auto step BYTE + Min value DOUBLE + Max value DOUBLE + Step DOUBLE + Cross DOUBLE + Value axis tick type BYTE + Placement of Value axis BYTE + Major lines BYTE + Value data colour BYTE + Value data font SHORT + 58 reserved BYTE [58] HOST DATA: + Pointer to memory PVOID + Selector for data USHORT + Segment length SHORT + Flag for test mode BYTE + Reserved BYTE RESERVED SPACE: + 128 reserved BYTE [128] VALUE DATA SERIES: + Number of columns SHORT LIST COL STRUCTS: + Connected field name CHAR [HAS_IDLEN + 1] + Connected field name item CHAR [HAS_IDLEN + 1] + List separator BYTE + Thousand separator BYTE + Decimal separator BYTE + 125 reserved BYTE [125]

Throws:

IOException - if an I/O error occurs.

Method Detail

equalsControl

protected boolean equalsControl(PhantomControl c)

Checks for control equality. The base is already checked and the Control ID, potential fore- and background color and color conversion flags. The tooltip text is not checked.

Specified by:

equalsControl in class PhantomControl

getControlObjectID

public String getControlObjectID()

Needs override by the control if the object instance if not resolved in this class instance.

Overrides:

getControlObjectID in class PhantomControl

Returns:

the Object ID connected to this control, null or empty string for none.

save

public void save(PhantomOutputFile file)
          throws IOException

Saves the instance of the control to file. BASE: + Type of business graphics SHORT + Base width SHORT + Pie sector angle SHORT + Field ID CHAR [HAS_IDLEN + 1] + Object name CHAR [HAS_FBLEN + 1] + Flag for legend BYTE + Stack values BYTE + Pie settings flag BYTE + Standard color BYTE + Standard font SHORT + Line diagram tick marks BYTE + List separator BYTE + Thousand separator BYTE + Decimal separator BYTE + 44 reserved BYTE [44] + 100 percent BYTE + Flag for border use BYTE + Legend alignment BYTE + Legend border BYTE + Legend standard colour BYTE + Legend standard font SHORT TEXTS: + Head standard colour BYTE + Head standard font SHORT + Value standard colour BYTE + Value standard font SHORT + Category standard colour BYTE + Category standard font SHORT + Lead text for heading CHAR [HAS_MAXFLDLEADLEN + 1] + Lead text for Value axis CHAR [HAS_MAXFLDLEADLEN + 1] + Lead text for Category axis CHAR [HAS_MAXFLDLEADLEN + 1] + Lead text reserved 1 CHAR [HAS_MAXFLDLEADLEN + 1] + Lead text reserved 2 CHAR [HAS_MAXFLDLEADLEN + 1] + Lead text reserved 3 CHAR [HAS_MAXFLDLEADLEN + 1] CATEGORIES: + Flag to draw Category axis BYTE + Flag to draw major lines BYTE + Category data CHAR [HAS_GRAPH_CATEGDATALEN + 1] + Connected field name CHAR [HAS_IDLEN + 1] + Categories tick type BYTE + Placement of categories BYTE + Categories mark interval SHORT + Categories interval SHORT + Categories crossing SHORT + Value cross middle BYTE + Category data color BYTE + Category data font SHORT + 61 reserved BYTE [61] VALUES: + Flag to draw Value axis BYTE + Auto min value BYTE + Auto max value BYTE + Auto step BYTE + Min value DOUBLE + Max value DOUBLE + Step DOUBLE + Cross DOUBLE + Value axis tick type BYTE + Placement of Value axis BYTE + Major lines BYTE + Value data color BYTE + Value data font SHORT + 58 reserved BYTE [58] HOST DATA: + Pointer to memory PVOID + Selector for data USHORT + Segment length SHORT + Flag for test mode BYTE + Reserved BYTE RESERVED SPACE: + 128 reserved BYTE [128] VALUE DATA SERIES: + Number of columns SHORT LIST COL STRUCTS: + Connected field name CHAR [HAS_IDLEN + 1] + Connected field name item CHAR [HAS_IDLEN + 1] + List separator BYTE + Thousand separator BYTE + Decimal separator BYTE + 125 reserved BYTE [125]

Specified by:

save in class PhantomControl

Parameters:

file -

Throws:

IOException - if an I/O error occurs.

rebind

public void rebind()

Re-bind the panel data.

Overrides:

rebind in class PhantomControl

getDataSize

public int getDataSize(PhantomOutputFile outputFile)

Get the size when saved to file.

Specified by:

getDataSize in class PhantomControl

updateReferences

public void updateReferences(ApplicationReferences refs)

Updates the Applications References instance.

Specified by:

updateReferences in class PhantomControl

addNPObjects

protected void addNPObjects(ENPObject obj)

Gets the NPObject for the control.

Specified by:

addNPObjects in class PhantomControl

getNPObjectExtra

protected String getNPObjectExtra()

Gets the "Extra" String for the NPObject.

Overrides:

getNPObjectExtra in class PhantomControl

isActionConnectedEnabled

public boolean isActionConnectedEnabled()

Checks if a control is action connected to another. E.g. for Copy/Paste operations.

Overrides:

isActionConnectedEnabled in class PhantomControl

encodeFont

public static int encodeFont(int face,
                             int size,
                             int attributes)

Encodes a font face, point size and attributes to a 16 bit UShort value. Valid face is 0-4, size 4-720.

Valid attributes are:

  0x01  Bold
  0x02  Italic
  0x04  Outline    (not supported)
  0x08  Strikeout  (not supported)
  0x10  Underscore
 

changeFont

public static int changeFont(int font,
                             int newFont,
                             boolean hasFontFace,
                             boolean hasFontSize,
                             boolean hasFontAttr)

Changes a font according to the flags.

reloadObject

public void reloadObject()
                  throws IOException

Reload object reference.

Specified by:

reloadObject in class PhantomControl

Throws:

IOException