se.entra.phantom.server

Class PhantomCNoteBook

java.lang.Object

se.entra.phantom.server.PhantomControl

se.entra.phantom.server.PhantomCNoteBook

All Implemented Interfaces:

Cloneable, PhantomControlFlags, PhantomControlType

public class PhantomCNoteBook
extends PhantomControl

This class loads the control definition from the Phantom Panel file.

Field Summary

Fields

Modifier and Type	Field and Description
PhantomCNoteBookAction	actionNext
PhantomCNoteBookAction	actionPrevious Notebook action previous/next.
static int	FLAG_3DFRAME
static int	FLAG_GLOBALPREVNEXT Global notebook flag.
static int	FLAG_GOF
static int	FLAG_NOTBOLD
static int	FLAG_PRELOADPAGES
static int	FLAG_RIGHTTOLEFT
int	flags
String	id Notebook control id.
PhantomPanelData	mainPanel The main panel where the notebook is located.
static int	MAX_NOTEBOOKPAGES Notebook pages (= panels).
int	notebookLook Notebook look: Win wrap, Win95 wrap or single line.
String	objectName Global object: name and object.
int	pageCount Number of notebook pages/panels.
PhantomCNoteBookPage[]	pages
int	tabFont Tab font.
int	tabPosition Tab position: top/bottom.

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

controlBase, controlColor, 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
PhantomCNoteBook(PhantomFile data) Constructor for Designer control.
PhantomCNoteBook(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.
boolean	doPreloadPages() Return preload pages flag.
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.
se.entra.phantom.geditor.NPPColor	getTabColor() Get tab foreground color.
boolean	has3dFrame() Return 3d frame flag.
boolean	isBold() Return bold flag.
boolean	isGlobalActionFlag() Return GlobalAction
boolean	performAction(VirtualPanel panel, boolean moveForward, int page, String argString) Perform action for one page or use global action if specified.
void	rebind() Re-bind the panel data.
void	reloadObject() Reload object reference.
void	resolveComponentReferences() Resolves panel ID to PhantomPanelData, after all panels has been loaded.
void	save(PhantomOutputFile file) Saves the instance of the control class 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, getNPObjectExtra, getNPObjectID, getObject, getObject, getPanelData, getReferencedFiles, getTypeDescription, getTypeDescriptionID, initializeDesignerControls, isActionConnectedEnabled, processColorConversion, processColorConversion, processColorConversion, processDisabledBackground, saveBase, setBackgroundColor, setForegroundColor, setIndex, updateGuiOnTheFlyValue

Methods inherited from class java.lang.Object

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

Field Detail

FLAG_GLOBALPREVNEXT

public static final int FLAG_GLOBALPREVNEXT

Global notebook flag.

See Also:

Constant Field Values

FLAG_3DFRAME

public static final int FLAG_3DFRAME

See Also:

Constant Field Values

FLAG_PRELOADPAGES

public static final int FLAG_PRELOADPAGES

See Also:

Constant Field Values

FLAG_RIGHTTOLEFT

public static final int FLAG_RIGHTTOLEFT

See Also:

Constant Field Values

FLAG_NOTBOLD

public static final int FLAG_NOTBOLD

See Also:

Constant Field Values

FLAG_GOF

public static final int FLAG_GOF

See Also:

Constant Field Values

flags

public int flags

pageCount

public int pageCount

Number of notebook pages/panels.

tabFont

public int tabFont

Tab font.

id

public String id

Notebook control id.

objectName

public String objectName

Global object: name and object.

tabPosition

public int tabPosition

Tab position: top/bottom.

notebookLook

public int notebookLook

Notebook look: Win wrap, Win95 wrap or single line.

mainPanel

public PhantomPanelData mainPanel

The main panel where the notebook is located.

MAX_NOTEBOOKPAGES

public static final int MAX_NOTEBOOKPAGES

Notebook pages (= panels).

See Also:

Constant Field Values

pages

public PhantomCNoteBookPage[] pages

actionPrevious

public PhantomCNoteBookAction actionPrevious

Notebook action previous/next.

actionNext

public PhantomCNoteBookAction actionNext

Constructor Detail

PhantomCNoteBook

public PhantomCNoteBook(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:
  + flags               ULONG
  + pageCount           SHORT
  + tabFont             SHORT
  + reserved            SHORT       (statusFont)
  + tabForeground       BYTE
  + reserved            BYTE        (tabBackground)
  + reserved            BYTE        (statusForeground)
  + reserved            BYTE        (statusBackground)
  + id                  BYTE [9]
  + objectName          BYTE [9]
  + reserved            BYTE [21]   (textPage1)
  + reserved            BYTE [21]   (textPage2)
  + reserved            BYTE [21]   (textPage3)
  + reserved            BYTE        (align1)
  + tabPosition         BYTE        (bMajorPos)
  + reserved            BYTE        (bPageBackPos)
  + notebookLook        SHORT       (sLook)
  + reserved            BYTE [92]

 Action previous/next:
  + flags               ULONG
  + sendKey             SHORT
  + objectName          BYTE [9]
  + hostFieldName       BYTE [9]
  + sendString          BYTE [32]
  + reserved            BYTE [72]
 
  + Notebook pages (numPages times)
 

Throws:

IOException - if an I/O error occurs.

PhantomCNoteBook

public PhantomCNoteBook(PhantomFile data)
                 throws IOException

Constructor for Designer control.

Throws:

IOException - if an I/O error occurs.

Method Detail

rebind

public void rebind()

Re-bind the panel data.

Overrides:

rebind in class PhantomControl

save

public void save(PhantomOutputFile file)
          throws IOException

Saves the instance of the control class to file.

 Base:
  + flags               ULONG
  + pageCount           SHORT
  + tabFont             SHORT
  + reserved            SHORT       (statusFont)
  + tabForeground       BYTE
  + reserved            BYTE        (tabBackground)
  + reserved            BYTE        (statusForeground)
  + reserved            BYTE        (statusBackground)
  + id                  BYTE [9]
  + objectName          BYTE [9]
  + reserved            BYTE [21]   (textPage1)
  + reserved            BYTE [21]   (textPage2)
  + reserved            BYTE [21]   (textPage3)
  + reserved            BYTE        (align1)
  + tabPosition         BYTE        (bMajorPos)
  + reserved            BYTE        (bPageBackPos)
  + notebookLook        SHORT       (sLook)
  + reserved            BYTE [92]

 Action previous/next:
  + flags               ULONG
  + sendKey             SHORT
  + objectName          BYTE [9]
  + hostFieldName       BYTE [9]
  + sendString          BYTE [32]
  + reserved            BYTE [72]
 
  + Notebook pages (numPages times)
 

Specified by:

save in class PhantomControl

Parameters:

file -

Throws:

IOException - if an I/O error occurs.

getDataSize

public int getDataSize(PhantomOutputFile outputFile)

Get the size when saved to file.

Specified by:

getDataSize in class PhantomControl

has3dFrame

public boolean has3dFrame()

Return 3d frame flag.

isBold

public boolean isBold()

Return bold flag.

isGlobalActionFlag

public boolean isGlobalActionFlag()

Return GlobalAction

doPreloadPages

public boolean doPreloadPages()

Return preload pages flag.

resolveComponentReferences

public void resolveComponentReferences()

Resolves panel ID to PhantomPanelData, after all panels has been loaded.

Overrides:

resolveComponentReferences in class PhantomControl

performAction

public boolean performAction(VirtualPanel panel,
                             boolean moveForward,
                             int page,
                             String argString)

Perform action for one page or use global action if specified.

getTabColor

public se.entra.phantom.geditor.NPPColor getTabColor()

Get tab foreground color.

reloadObject

public void reloadObject()
                  throws IOException

Reload object reference.

Specified by:

reloadObject in class PhantomControl

Throws:

IOException

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

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.

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