EditorDirectInterface (NetPhantom® 8.0 Java API Specification)

All Known Implementing Classes:
TerminalMouseHandler
```
public interface EditorDirectInterface
```
The interface which allows programmatically access to editor. This means the mode, screens and marks are accessed without implicit user interaction (message boxes, dialogs). However, the interface contains methods for explicit user interaction.
Author:
Mikael Andersson

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`boolean`	`closeProjectDirect()` Close the current application.
`HostPopupWindow.Rect`	`getConstrainingPopup()` Get the constraining pop-up.
`se.entra.phantom.server.phed.FieldDecoratedMark`	`getLastField(se.entra.phantom.server.phed.FieldDecoratedMark current)` Get the last host field that is not equal to the indicated one.
`se.entra.phantom.server.phed.FieldDecoratedMark`	`getLastNormalField(se.entra.phantom.server.phed.FieldDecoratedMark current)` Get the last defined host field that is not a continued field and is different from the indicated one.
`se.entra.phantom.server.phed.DecoratedMarks`	`getMarks()` Get the marks container.
`String`	`getNewFieldName()` Get a new field name.
`PhantomHostScreen`	`getPhantomHostScreen()` Get the phantom host screen.
`boolean`	`isEdited()` Is this phantom host screen edited.
`int`	`messageBox(int type, int icon, String message, String title)` Display a message box.
`void`	`populateMarks(PhantomHostScreen screen)` Populate marks programmatically.
`void`	`populateMarksDirect(PhantomHostScreen screen)` Read the screen definition and populate the mark container directly (i.e.
`boolean`	`saveScreenDefinitionDirect()` Save the screen definition in the PhantomHostData structure.
`boolean`	`setConstrainedDirect(HostPopupWindow.Rect constraint)` Set whether the window should be constrained (i.e.
`void`	`setCurrentMark(se.entra.phantom.server.phed.DecoratedMark newMark)` Sets the current mark.
`boolean`	`setCurrentScreenDirect(PhantomHostScreen newScreen)` Set the current screen programmatically.
`void`	`setEdited(boolean edited)` Set the phantom host screen as edited.
`boolean`	`setModeDirect(int newMode)` Set the current mode directly (i.e.

- Method Detail
  - closeProjectDirect
```
boolean closeProjectDirect()
```
    Close the current application.
    Returns:
    boolean - true if successful, false otherwise.
  - getConstrainingPopup
```
HostPopupWindow.Rect getConstrainingPopup()
```
    Get the constraining pop-up.
    Returns:
    HostPopupWindow.Rect, or null for none.
  - getMarks
```
se.entra.phantom.server.phed.DecoratedMarks getMarks()
```
    Get the marks container.
    Returns:
    DecoratedMarks
  - getPhantomHostScreen
```
PhantomHostScreen getPhantomHostScreen()
```
    Get the phantom host screen.
    Returns:
    PhantomHostScreen
  - getNewFieldName
```
String getNewFieldName()
```
    Get a new field name.
    Returns:
    String - a newly generated, and unique field name
  - messageBox
```
int messageBox(int type,
               int icon,
               String message,
               String title)
```
    Display a message box.
    Parameters:
    type -
    icon -
    message -
    title -
    Returns:
    The return code.
  - setConstrainedDirect
```
boolean setConstrainedDirect(HostPopupWindow.Rect constraint)
```
    Set whether the window should be constrained (i.e. programmatically - without displaying pop-ups, etc.). Return true if successful.
    Parameters:
    constraint - The constraints rectangle.
    Returns:
    boolean - true if successful, false otherwise.
  - populateMarksDirect
```
void populateMarksDirect(PhantomHostScreen screen)
```
    Read the screen definition and populate the mark container directly (i.e. programmatically - without displaying pop-ups, etc and not based on the under-lying host screen). Base offset of marks on the current constraining rectangle.
    Parameters:
    screen - The PhantomHostScreen to populate marks on.
  - getLastNormalField
```
se.entra.phantom.server.phed.FieldDecoratedMark getLastNormalField(se.entra.phantom.server.phed.FieldDecoratedMark current)
```
    Get the last defined host field that is not a continued field and is different from the indicated one.
    Parameters:
    current - The FieldDecoratedMark reference.
    Returns:
    The last FieldDecoratedMark in a normal field, null for none.
  - getLastField
```
se.entra.phantom.server.phed.FieldDecoratedMark getLastField(se.entra.phantom.server.phed.FieldDecoratedMark current)
```
    Get the last host field that is not equal to the indicated one.
    Parameters:
    current - A FieldDecoratedMark of a host field, first or in the middle.
    Returns:
    The last field as FieldDecoratedMark, null for none.
  - saveScreenDefinitionDirect
```
boolean saveScreenDefinitionDirect()
```
    Save the screen definition in the PhantomHostData structure.
    Returns:
    boolean - true if successful, false otherwise.
  - setModeDirect
```
boolean setModeDirect(int newMode)
```
    Set the current mode directly (i.e. programmatically - without displaying pop-ups, etc.) The action is either successful (and returns true) or not entirely. This action is atomic. Note: This method should not be called to implicitly create a new PhantomHostScreen. This will fail!
    Parameters:
    newMode - The new mode.
    Returns:
    boolean - true if successful, false otherwise.
  - setCurrentMark
```
void setCurrentMark(se.entra.phantom.server.phed.DecoratedMark newMark)
```
    Sets the current mark.
    Parameters:
    newMark - The new DecoratedMark.
  - setCurrentScreenDirect
```
boolean setCurrentScreenDirect(PhantomHostScreen newScreen)
```
    Set the current screen programmatically.
    Parameters:
    newScreen - The new PhantomHostScreen.
    Returns:
    boolean - true if successful, false otherwise.
  - populateMarks
```
void populateMarks(PhantomHostScreen screen)
```
    Populate marks programmatically.
    Parameters:
    screen - The PhantomHostScreen.
  - isEdited
```
boolean isEdited()
```
    Is this phantom host screen edited.
    Returns:
    boolean Edited flag.
  - setEdited
```
void setEdited(boolean edited)
```
    Set the phantom host screen as edited.
    Parameters:
    edited - The edited flag.

Interface EditorDirectInterface

Method Summary

Method Detail

closeProjectDirect

getConstrainingPopup

getMarks

getPhantomHostScreen

getNewFieldName

messageBox

setConstrainedDirect

populateMarksDirect

getLastNormalField

getLastField

saveScreenDefinitionDirect

setModeDirect

setCurrentMark

setCurrentScreenDirect

populateMarks

isEdited

setEdited