ServerExports (P2J - Progress 4GL to Java Conversion and Runtime)

```
public interface ServerExports
```
Defines all UI-related API's exported by the server for use by the client.

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`boolean`	`applyEnhancedConfig(int browseId, EnhancedBrowseConfig config)` Apply the given enhanced browse configuration to the given browse.
`int`	`connectEvent(long resourceId, long clientSocketId)` Called by the P2J client side, it will inform the server that a server event was generated.
`long`	`createExternal()` Create an external resource to be used by a remote, non P2J, side.
`long`	`createSocket(int id)` Create a socket and associated with the given ID.
`void`	`deleteHandle(long handleId, boolean noError)` Delete the resource associated with the specified handle.
`ServerReturnValue`	`emitComEvent(int widgetId, java.lang.String eventName, BaseDataType... args)` Emits the supplied COM event.
`void`	`endSpreadsheetBatch(int contextId)` Ends the current batch of spreadsheet commands.
`void`	`forkNewSession()` Creates a new session forked from the current one.
`java.lang.String[]`	`getColumnFiltersMappedDataTypes(int browseId)` For enhanced filtering: get data types of the fields mapped using `DB-FILTER-FIELD-MAPPING`.
`int`	`getCurrentRow(int browseId)` Get current row in the query.
`java.util.Map<java.lang.String,byte[]>`	`getCustomFontData()` Returns font data in a form of map where key is the lower-cased name as defined in server directory "custom-font" container and map value is the raw file data of respective font files.
`WidgetConfig[]`	`getEditorsConfigs(int browseId)` Get configurations of widgets used for in-browse editing (fill-ins, toggle-boxes or combo-boxes).
`EnhancedBrowseSaveTarget[]`	`getEnhancedBrowseResetTargets(int browseId)` Get enhanced browse configuration reset targets available for the target browse and the current user.
`EnhancedBrowseSaveTarget[]`	`getEnhancedBrowseSaveTargets(int browseId)` Get save targets for an enhanced browse configuration, which are available for the current user.
`boolean`	`getForceDialogsInCenter(boolean defaultValue)` Gets the value for the flag indicating whether or not dialogs should appear in the center of the screen,
`int`	`getGuiSubMenuDelay(int defaultDelay)` Gets the value for sub menu show/hide delay in GUI mode.
`java.lang.Integer`	`getHTMLBrowserLoadTimeout()` Retrieve the number of milliseconds to wait when loading a HTML web page.
`KeyboardLayoutsSettings`	`getKeyboardLayoutsSettings()` Gets the supported keyboard layouts defined by the directory.
`int[]`	`getLegacyTextMetrics(java.lang.String text, java.lang.String key)` Get the legacy metrics for the given text, using the font specified by the given key.
`java.lang.String[]`	`getProgressStackTrace()` Get the Progress stack trace
`java.lang.String`	`getRequiredTheme()` Returns the theme class / name configured in directory as "theme/name" or `null` if it isn't configured or isn't a valid class / short name (for built-in themes).
`java.lang.Long`	`getResourceIdByWidgetId(int widgetId)` Gets the widget's resource id.
`int`	`getRowCount(int browseId)` Get the number of rows iterated by the query (for preselect queries - matches result size, for adaptive queries - matches the size of the part of the result set the query has already iterated over).
`int`	`getRowCount(int browseId, int startRow)` Get number of available rows starting from the given one.
`BrowseRow[]`	`getRows(int browseId, char searchChar, int searchColumn, int viewportTopRow, int viewportBottomRow, int rowDisplayTriggerId, ScreenBuffer[] sb)` This function is used when search by key is performed in a browse.
`BrowseRow[]`	`getRows(int browseId, int startRowIndex, int count, boolean forward, int rowDisplayTriggerId, ScreenBuffer[] sb, RowDisplayStrategy displayStrategy)` Retrieves several subsequent rows from the database.
`boolean`	`getSessionTooltips()` Accesses the SESSION:TOOLTIPS attribute for this session.
`java.util.Map<java.lang.String,java.util.List<java.lang.String>>`	`getSupportedHelperApplications()` Gets the supported helper applications with their mime types.
`java.util.List<ThemeOption>`	`getThemes()` Returns a collection of all the valid themes configured in directory as @available-themes@.
`int[]`	`getUploadFileSizeLimits()` Gets the values for uploaded file size limits from server.
`void`	`help(int lastKey, ScreenBuffer[] buffer)` Locates and executes a preconfigured HELP application.
`ServerReturnValue`	`invoke(InvocationRequestPayload request)` This API is used when P2J client runs in embedded mode (i.e.
`ServerReturnValue`	`invokeInProcedure(java.lang.String procedure, java.lang.String inProcHandle, java.lang.Object... params)` Invoke an internal procedure with the specified name.
`ServerReturnValue`	`invokeProcedure(java.lang.String procedure, java.lang.Object... params)` Invoke an internal procedure with the specified name.
`ServerReturnValue`	`invokeServerEvent(int id)` Called from the client-side, it executes the server-side event by calling `ServerEvent.invoke(int)`.
`boolean`	`isBypassDefaultWindowShowInPauseNoMessage(boolean defaultValue)` Gets the value for the flag indicating whether or not pause x no message should enable the default-window
`boolean`	`isOldBrowseSelectionBar()` Returns `true` if the selected browse row is drawn in the "old" mode, which is drawing it opaque using the highlight colors, rather than drawing it translucent.
`boolean`	`isRowAvailable(int browseId, int rowIndex)` Determines if the specified browse row is "available", i.e.
`byte[]`	`loadEnvironment(java.lang.String env)` Load the specified environment as resource.
`void`	`messageBlasterEvent(long id, int msgVal, int wParam, int lParam, int lplRetVal)` Sends a `MessageBlaster` notification back to server.
`void`	`moveColumnServer(int browseId, int src, int dest)` Implements the server-side MOVE-COLUMN() widget method.
`void`	`notifyBrowseLayoutPerformed(int browseId)` Notify server that browse layout has been performed on the client side.
`void`	`openHyperlink(int columnWidgetId, java.lang.String hyperlinkText)` Open the hyperlink in the browse column by raising the event previously set for this column using the HYPERLINK attribute (FWD extension).
`void`	`publishExternal(java.lang.String event, long publisher, java.lang.String[] args)` Notify all subscribers (to the given event) that the event has occurred.
`ColorTable.EnvironmentColorTable`	`readColorTable(java.lang.String envName)` Get color table of the specified environment.
`FontDetails<?>[]`	`readDefaultFonts(boolean useIni)` Read the default fonts.
`FontDetails<?>[]`	`readFontTable()` Read the entire font-table.
`java.util.Map<java.lang.String,java.net.URI>`	`readHtmlBrowserWhitelist()` Retrieve all local paths whitelisted as resource-base for html web browser.
`java.util.Map<java.lang.String,int[]>`	`readLegacyTextMetrics()` Read the legacy text metrics for all the texts and each font defined in the font table, for this user.
`int`	`readResponseEvent(long resourceId)` Called by the P2J client side, it will inform the server that a server-event was generated.
`ColorTableEntry[]`	`readSystemColorTable()` Get system colors.
`FontDetails<?>[]`	`readSystemFontTable()` Read the font-table with the name of the legacy system fonts.
`ScreenBuffer[]`	`refresh(int frameId)` Obtains the latest screen buffer associated with the given frame.
`void`	`refreshBuffers(ScreenBuffer[] buff)` Refresh the server-side screen buffer for the given frame.
`void`	`requestNodeExpand(int treeWidgetId, int nodeId, boolean expand, boolean allChildren)` Clients use this method to request node expansion status change.
`EhBrowseConfigKey`	`resetEnhancedConfig(int browseId, EnhancedBrowseSaveTarget resetTarget)` Reset (delete) an enhanced configuration at the certain level for this browse.
`void`	`resetWaitState()` Resets wait-state previously set by `LogicalTerminal.setWaitState(String)`.
`boolean`	`runReport(int browseId, java.lang.String outputFileName, MediaType outputFormat, ScreenBuffer[] sb)` Run browse report.
`EnhancedBrowseConfig`	`saveOrCacheEnhancedConfig(int browseId, EnhancedBrowseSaveTarget saveTarget)` Save the current enhanced browse configuration using the specified save target.
`void`	`setClientMetrics(ClientMetrics metrics)` Sets the client metrics in the current session.
`int`	`setCurrentRow(int browseId, int rowIndex)` Inform server about current row in the browse.
`void`	`setDynamicFiltering(int browseId, int[] columnOrdinals, BaseDataType[] values)` Set dynamic filtering for the browse.
`void`	`setDynamicSorting(int browseId, int[] columnOrdinals, boolean[] ascending)` Set dynamic sorting for the browse.
`void`	`setThemePreferredFonts(java.util.Map<java.lang.String,java.lang.String> themeFonts, java.util.Map<java.lang.String,java.lang.String> themeFontAliases)` Set the theme preferred fonts.
`void`	`sortTreeList(int widgetId, int index, boolean resetSorting)` Sorts a tree list widget by a column.
`long`	`subscribeExternal(boolean global, java.lang.Long subscriber, java.lang.String event, java.lang.Long publisher, boolean noError)` Create a new subscription to the given event for a specified external resource.
`ServerReturnValue`	`trigger(int triggerId, int eventId, int sourceId, int otherId, long resourceId, int matchedWidgetId, int rowSourceId, ScreenBuffer[] sb)` Signals a trigger to the application.
`void`	`unsubscribeExternal(boolean global, java.lang.Long subscriber, java.lang.String event, java.lang.Long publisher)` Delete a subscription to the given event for the specified external resource.
`void`	`updateRow(int browseId, int rowIndex, int[] cellIndices, BaseDataType[] cellValues, boolean onlyNotifyRowReleased)` Updates selected cells in the given row.
`ValidationResult`	`validate(int sourceId, ScreenBuffer[] sb)` Signals a validation event to the application.
`boolean`	`validResource(long id)` Check if the resource with the given id is still valid to be used in a WAIT-FOR statement.

- Method Detail
  - invokeServerEvent
```
ServerReturnValue invokeServerEvent(int id)
```
    Called from the client-side, it executes the server-side event by calling ServerEvent.invoke(int).
    
    Parameters:
    
    id - The id of the server event.
  - validResource
```
boolean validResource(long id)
```
    Check if the resource with the given id is still valid to be used in a WAIT-FOR statement. It will return false if:
    - there is no resource associated with the given id or the resource is unknown.
    - the SENSITIVE attribute for the resource is false.
    - the resource is not valid.
    In all other cases, it will return true
    Parameters:
    
    id - The resource id.
    
    Returns:
    
    See above.
  - getResourceIdByWidgetId
```
java.lang.Long getResourceIdByWidgetId(int widgetId)
```
    Gets the widget's resource id.
    
    Parameters:
    
    widgetId - The widget id.
    
    Returns:
    
    The resource id.
  - trigger
```
ServerReturnValue trigger(int triggerId,
                          int eventId,
                          int sourceId,
                          int otherId,
                          long resourceId,
                          int matchedWidgetId,
                          int rowSourceId,
                          ScreenBuffer[] sb)
```
    Signals a trigger to the application. If a trigger is registered for this event and source widget combination, then it will be executed.
    
    Parameters:
    
    triggerId - The trigger to be called.
    
    eventId - The event which was generated.
    
    sourceId - The widget which generated the event.
    
    otherId - The companion widget id (for ENTER/LEAVE).
    
    resourceId - The resource which generated the event.
    
    matchedWidgetId - Id of the widget that actually matched the trigger.
    
    rowSourceId - Id of the WIDGET-ENTER/WIDGET-LEAVE widget for a ROW-ENTRY/ROW-LEAVE event.
    
    sb - The editable frames ScreenBuffer array
    
    Returns:
    
    A container including the ScreenBuffer representing the latest screen values of all widgets and the consume flag.
  - validate
```
ValidationResult validate(int sourceId,
                          ScreenBuffer[] sb)
```
    Signals a validation event to the application.
    This signal is used to trigger validation execution on the server.
    
    Parameters:
    
    sourceId - widget ID of the widget generated the trigger.
    
    sb - The ScreenBuffer array for current and other editable buffers.
    
    Returns:
    
    ValidationResult representing the validation result, error message and screen value changes.
  - help
```
void help(int lastKey,
          ScreenBuffer[] buffer)
```
    Locates and executes a preconfigured HELP application.
    
    Parameters:
    
    lastKey - The most recent key event code
    
    buffer - The screen buffer array associated with the FOCUS as before HELP is invoked and other editable frames.
  - refresh
```
ScreenBuffer[] refresh(int frameId)
```
    Obtains the latest screen buffer associated with the given frame.
    
    Parameters:
    
    frameId - The frame for which the screen buffer should be returned.
    
    Returns:
    
    ScreenBuffer array representing the current screen values of all widgets in the given frame and other editable frames.
  - getEditorsConfigs
```
WidgetConfig[] getEditorsConfigs(int browseId)
```
    Get configurations of widgets used for in-browse editing (fill-ins, toggle-boxes or combo-boxes).
    
    Parameters:
    
    browseId - ID of the browse which should handle the request.
    
    Returns:
    
    Array of configurations of widgets used for in-browse editing (fill-ins, toggle-boxes or combo-boxes). An array element is configuration of the widget for the corresponding editable column or null if the column is not editable. Return value is null if the browse is read-only.
  - getRowCount
```
int getRowCount(int browseId)
```
    Get the number of rows iterated by the query (for preselect queries - matches result size, for adaptive queries - matches the size of the part of the result set the query has already iterated over).
    
    Parameters:
    
    browseId - ID of the browse which should handle the request.
    
    Returns:
    
    number of iterated rows in the result set.
  - getRowCount
```
int getRowCount(int browseId,
                int startRow)
```
    Get number of available rows starting from the given one.
    
    Parameters:
    
    browseId - ID of the browse which should handle the request.
    
    startRow - Initial row to start count rows from.
    
    Returns:
    
    Number of available rows.
  - getRows
```
BrowseRow[] getRows(int browseId,
                    int startRowIndex,
                    int count,
                    boolean forward,
                    int rowDisplayTriggerId,
                    ScreenBuffer[] sb,
                    RowDisplayStrategy displayStrategy)
```
    Retrieves several subsequent rows from the database.
    
    Parameters:
    
    browseId - ID of the browse which should handle the request.
    
    startRowIndex - Index of the first row to retrieve (0-based).
    
    count - Maximum count of rows to return. -1 for no limit.
    
    forward - true if rows are retrieved in the forward direction, false if rows are retrieved in the backward direction,
    
    rowDisplayTriggerId - Trigger ID of the ROW-DISPLAY trigger. -1 if there is no ROW-DISPLAY trigger for this browse.
    
    sb - Screen buffer for the ROW-DISPLAY trigger. null if there is no ROW-DISPLAY trigger for this browse.
    
    displayStrategy - Specifies type of action for which rows are fetched and defines how rows are iterated / displayed.
    
    Returns:
    
    Array of rows. Each row is array of cell values, but the first element of the row array is 0-based index of the row in the browse model. Note that if rows are fetched in the backward direction, the resulting rows are returned in the straight order starting from the row with the least row number. If no query is specified or the query is closed, null is returned.
  - getRows
```
BrowseRow[] getRows(int browseId,
                    char searchChar,
                    int searchColumn,
                    int viewportTopRow,
                    int viewportBottomRow,
                    int rowDisplayTriggerId,
                    ScreenBuffer[] sb)
```
    This function is used when search by key is performed in a browse. Retrieves the set of rows which should be in view after search is completed. There are complex rules which determine the top row of the view depending on how the current row is positioned relatively to the current view and how the found row is positioned relatively to the current view and to the current row.
    
    Parameters:
    
    browseId - ID of the browse which should handle the request.
    
    searchChar - Character to be searched for. Search is performed using only the first character (in the visual data representation) in the current column. Specifying a character puts this function in the search mode. This parameter is null for non-search mode.
    
    searchColumn - For search mode: 0-based index of the column to be searched.
    
    viewportTopRow - For search mode: 0-based index (in the result set) of the top row in the current view.
    
    viewportBottomRow - For search mode: 0-based index (in the result set) of the bottom row in the current view.
    
    rowDisplayTriggerId - Trigger ID of the ROW-DISPLAY trigger. -1 if there is no ROW-DISPLAY trigger for this browse.
    
    sb - Screen buffer for the ROW-DISPLAY trigger. null if there is no ROW-DISPLAY trigger for this browse.
    
    Returns:
    
    Array of rows. Each row is array of cell values, but the first element of the row array is 0-based index of the row in the browse model. If no query is specified or the query is closed, null is returned.
  - updateRow
```
void updateRow(int browseId,
               int rowIndex,
               int[] cellIndices,
               BaseDataType[] cellValues,
               boolean onlyNotifyRowReleased)
        throws DataValidationException
```
    Updates selected cells in the given row.
    
    Parameters:
    
    browseId - ID of the browse which should handle the request.
    
    rowIndex - Index of the row to update.
    
    cellIndices - Cells for update indexes.
    
    cellValues - Cells for update new values.
    
    onlyNotifyRowReleased - Only notify server that the row has been released. Data is not updated.
    
    Throws:
    
    DataValidationException - New values don't passed database validation rules.
  - setCurrentRow
```
int setCurrentRow(int browseId,
                  int rowIndex)
```
    Inform server about current row in the browse.
    
    Parameters:
    
    browseId - ID of the browse which should handle the request.
    
    rowIndex - 0-based index of the current row.
    
    Returns:
    
    New current row.
  - getCurrentRow
```
int getCurrentRow(int browseId)
```
    Get current row in the query.
    
    Parameters:
    
    browseId - ID of the browse which should handle the request.
    
    Returns:
    
    The current row index.
  - isRowAvailable
```
boolean isRowAvailable(int browseId,
                       int rowIndex)
```
    Determines if the specified browse row is "available", i.e. it is not deleted.
    
    Parameters:
    
    browseId - ID of the browse which should handle the request.
    
    rowIndex - 0-base index of the target row in the browse model.
    
    Returns:
    
    true if the row is "available", i.e. it is not deleted.
  - runReport
```
boolean runReport(int browseId,
                  java.lang.String outputFileName,
                  MediaType outputFormat,
                  ScreenBuffer[] sb)
```
    Run browse report.
    
    Parameters:
    
    browseId - ID of the browse which should handle the request.
    
    outputFileName - Name of the output file.
    
    outputFormat - Format of the output format.
    
    sb - The screen buffer array data.
    
    Returns:
    
    true on success.
  - getEnhancedBrowseSaveTargets
```
EnhancedBrowseSaveTarget[] getEnhancedBrowseSaveTargets(int browseId)
```
    Get save targets for an enhanced browse configuration, which are available for the current user.
    
    Parameters:
    
    browseId - ID of the browse which should handle the request.
    
    Returns:
    
    see above.
  - getColumnFiltersMappedDataTypes
```
java.lang.String[] getColumnFiltersMappedDataTypes(int browseId)
```
    For enhanced filtering: get data types of the fields mapped using DB-FILTER-FIELD-MAPPING. They are used in column filters. E.g. if a column has DB-FILTER-FIELD-MAPPING set to "some-table.some-date-field", data type from this column would be "date".
    
    Parameters:
    
    browseId - ID of the browse which should handle the request.
    
    Returns:
    
    array of data types, each array element corresponds a browse column. If a column doesn't have DB-FILTER-FIELD-MAPPING set, corresponding array element is null.
  - getEnhancedBrowseResetTargets
```
EnhancedBrowseSaveTarget[] getEnhancedBrowseResetTargets(int browseId)
```
    Get enhanced browse configuration reset targets available for the target browse and the current user. It is a list of levels which have existing enhanced browse configurations defined for the target browse, filtered according to the user's access rights.
    
    Parameters:
    
    browseId - ID of the browse which should handle the request.
    
    Returns:
    
    see above.
  - resetEnhancedConfig
```
EhBrowseConfigKey resetEnhancedConfig(int browseId,
                                      EnhancedBrowseSaveTarget resetTarget)
```
    Reset (delete) an enhanced configuration at the certain level for this browse.
    
    Parameters:
    
    browseId - ID of the browse which should handle the request.
    
    resetTarget - Defines the level at which the configuration will be reset.
    
    Returns:
    
    key of the configuration that has been deleted or null if there is no configuration at this level.
  - applyEnhancedConfig
```
boolean applyEnhancedConfig(int browseId,
                            EnhancedBrowseConfig config)
```
    Apply the given enhanced browse configuration to the given browse.
    
    Parameters:
    
    browseId - ID of the browse which should handle the request.
    
    config - Enhanced browse configuration to apply.
    
    Returns:
    
    true on success.
  - saveOrCacheEnhancedConfig
```
EnhancedBrowseConfig saveOrCacheEnhancedConfig(int browseId,
                                               EnhancedBrowseSaveTarget saveTarget)
```
    Save the current enhanced browse configuration using the specified save target. If the configuration is supposed to be stored on the client side then on the server side it is only cached.
    
    Parameters:
    
    browseId - ID of the browse which should handle the request.
    
    saveTarget - Save target (if configuration is applied to "all browses" / "specific browse" and "all users" / "current user").
    
    Returns:
    
    the configuration that has been saved or cached. null on error.
  - moveColumnServer
```
void moveColumnServer(int browseId,
                      int src,
                      int dest)
```
    Implements the server-side MOVE-COLUMN() widget method.
    Repositions a column in the browse widget.
    
    Parameters:
    
    browseId - ID of the browse which should handle the request.
    
    src - 0-based position of the column to be moved (column ordinal).
    
    dest - 0-based position to which the column is moved (column ordinal).
  - notifyBrowseLayoutPerformed
```
void notifyBrowseLayoutPerformed(int browseId)
```
    Notify server that browse layout has been performed on the client side.
    
    Parameters:
    
    browseId - ID of the browse which should handle the request.
  - readResponseEvent
```
int readResponseEvent(long resourceId)
```
    Called by the P2J client side, it will inform the server that a server-event was generated. Although the event originates from the P2J Client Side, socket events are server-side events.
    
    Parameters:
    
    resourceId - The resource ID for the socket to which the READ-RESPONSE event belongs.
    
    Returns:
    
    The ID of the generated server event or -1 if a event could not be posted (i.e. the resource is not SENSITIVE).
  - connectEvent
```
int connectEvent(long resourceId,
                 long clientSocketId)
```
    Called by the P2J client side, it will inform the server that a server event was generated. Although the event originates from the P2J Client Side, socket events are server-side events.
    
    Parameters:
    
    resourceId - The resource ID for the server socket to which the CONNECT event belongs.
    
    clientSocketId - The resource ID of the socket created for the new connected accepted by the server socket.
    
    Returns:
    
    The ID of the generated server event or -1 if a event could not be posted (i.e. the resource is not SENSITIVE).
  - createSocket
```
long createSocket(int id)
```
    Create a socket and associated with the given ID. The received ID is not a resource ID; this represents the ID of the associated LowLevelSocketImpl instance.
    
    Parameters:
    
    id - The ID of the associated LowLevelSocketImpl instance.
    
    Returns:
    
    The ID of the created SocketImpl resource.
  - getRequiredTheme
```
java.lang.String getRequiredTheme()
```
    Returns the theme class / name configured in directory as "theme/name" or null if it isn't configured or isn't a valid class / short name (for built-in themes).
    
    Returns:
    
    See above.
  - getThemes
```
java.util.List<ThemeOption> getThemes()
```
    Returns a collection of all the valid themes configured in directory as @available-themes@. Returns null if "theme/name" is configured with a valid theme.
    
    Returns:
    
    See above.
  - isOldBrowseSelectionBar
```
boolean isOldBrowseSelectionBar()
```
    Returns true if the selected browse row is drawn in the "old" mode, which is drawing it opaque using the highlight colors, rather than drawing it translucent.
    
    Returns:
    
    see above.
  - getUploadFileSizeLimits
```
int[] getUploadFileSizeLimits()
```
    Gets the values for uploaded file size limits from server.
    
    Returns:
    
    The file size limits values. Index 0 is for per file limit, 1 - total limit, 2 - the file size threshold for writing data to the disk
  - getGuiSubMenuDelay
```
int getGuiSubMenuDelay(int defaultDelay)
```
    Gets the value for sub menu show/hide delay in GUI mode. 0 value disables delay functionality.
    
    Parameters:
    
    defaultDelay - The default value to be used if the current value is nod configured on server side directory config file.
    
    Returns:
    
    The sub menu delay in milliseconds fo show/hide submenu or 0 to disable delay.
  - getForceDialogsInCenter
```
boolean getForceDialogsInCenter(boolean defaultValue)
```
    Gets the value for the flag indicating whether or not dialogs should appear in the center of the screen,
    
    Parameters:
    
    defaultValue - The default value to be used if the current value is not configured on server side directory config file.
    
    Returns:
    
    The boolean flag indicating if dialogs should be forcibly placed in the screen center.
  - isBypassDefaultWindowShowInPauseNoMessage
```
boolean isBypassDefaultWindowShowInPauseNoMessage(boolean defaultValue)
```
    Gets the value for the flag indicating whether or not pause x no message should enable the default-window
    
    Parameters:
    
    defaultValue - The default value to be used if the current value is not configured on server side directory config file.
    
    Returns:
    
    The boolean flag indicating if pause x no message should enable the default-window.
  - readSystemFontTable
```
FontDetails<?>[] readSystemFontTable()
```
    Read the font-table with the name of the legacy system fonts.
    
    Returns:
    
    The font table. As 4GL does, this is 0-indexed.
  - readFontTable
```
FontDetails<?>[] readFontTable()
```
    Read the entire font-table.
    
    Returns:
    
    The font table. As 4GL does, this is 0-indexed.
  - setThemePreferredFonts
```
void setThemePreferredFonts(java.util.Map<java.lang.String,java.lang.String> themeFonts,
                            java.util.Map<java.lang.String,java.lang.String> themeFontAliases)
```
    Set the theme preferred fonts.
    
    Parameters:
    
    themeFonts - The fonts the current installed Theme on client prefers.
    
    themeFontAliases - The font aliases currently installed Theme on client prefers.
  - readDefaultFonts
```
FontDetails<?>[] readDefaultFonts(boolean useIni)
```
    Read the default fonts.
    
    Parameters:
    
    useIni - true to load the default fonts from the ini file specified for the client. false to load the default fonts from the directory.
    
    Returns:
    
    An array with the font details, with default font on index o and default fixed font on index 1.
  - getKeyboardLayoutsSettings
```
KeyboardLayoutsSettings getKeyboardLayoutsSettings()
```
    Gets the supported keyboard layouts defined by the directory.
    
    Returns:
    
    The keyboard layouts settings
  - getHTMLBrowserLoadTimeout
```
java.lang.Integer getHTMLBrowserLoadTimeout()
```
    Retrieve the number of milliseconds to wait when loading a HTML web page. This works as a timeout.
    
    Returns:
    
    An integer representing the HTML browser load timeout.
  - getSupportedHelperApplications
```
java.util.Map<java.lang.String,java.util.List<java.lang.String>> getSupportedHelperApplications()
```
    Gets the supported helper applications with their mime types.
    
    Returns:
    
    The the supported helper applications
  - getLegacyTextMetrics
```
int[] getLegacyTextMetrics(java.lang.String text,
                           java.lang.String key)
```
    Get the legacy metrics for the given text, using the font specified by the given key.
    
    Parameters:
    
    text - The text.
    
    key - The font's key.
    
    Returns:
    
    The legacy metrics, with width on index 0 and height on index 1.
  - readLegacyTextMetrics
```
java.util.Map<java.lang.String,int[]> readLegacyTextMetrics()
```
    Read the legacy text metrics for all the texts and each font defined in the font table, for this user.
    
    Returns:
    
    A map having as key the font and text and as value the metrics (0 index - width, 1 index - height).
  - readColorTable
```
ColorTable.EnvironmentColorTable readColorTable(java.lang.String envName)
```
    Get color table of the specified environment.
    
    Parameters:
    
    envName - Environment name. Could be null if is default environment.
    
    Returns:
    
    see above.
  - readSystemColorTable
```
ColorTableEntry[] readSystemColorTable()
```
    Get system colors.
    
    Returns:
    
    System colors
  - loadEnvironment
```
byte[] loadEnvironment(java.lang.String env)
```
    Load the specified environment as resource. The environment is stored in an INI file embedded as a resource inside application jar file.
    
    Parameters:
    
    env - The INI file source.
    
    Returns:
    
    The environment file bytes, or null if the environment file could not be loaded.
  - getSessionTooltips
```
boolean getSessionTooltips()
```
    Accesses the SESSION:TOOLTIPS attribute for this session.
    
    Returns:
    
    true if tooltips are available for this session false otherwise.
  - refreshBuffers
```
void refreshBuffers(ScreenBuffer[] buff)
```
    Refresh the server-side screen buffer for the given frame.
    
    Parameters:
    
    buff - The screen buffer array data to be refreshed. May be null.
  - getProgressStackTrace
```
java.lang.String[] getProgressStackTrace()
```
    Get the Progress stack trace
    
    Returns:
    
    the Progress stack trace
  - invoke
```
ServerReturnValue invoke(InvocationRequestPayload request)
```
    This API is used when P2J client runs in embedded mode (i.e. the P2J screens are embedded into another customer-specific application). It allows the customer-specific to execute converted 4GL code. Only external programs, procedures and functions can be invoked. The result of this invocation (and any additional OUTPUT parameters, errors, etc) will be returned back to the customer-specific application.
    
    Parameters:
    
    request - The details about the request.
    
    Returns:
    
    The response for this request.
  - invokeProcedure
```
ServerReturnValue invokeProcedure(java.lang.String procedure,
                                  java.lang.Object... params)
```
    Invoke an internal procedure with the specified name.
    
    Parameters:
    
    procedure - The procedure name.
    
    params - The parameters.
    
    Returns:
    
    A response holding the RETURN-VALUE for this procedure call.
  - invokeInProcedure
```
ServerReturnValue invokeInProcedure(java.lang.String procedure,
                                    java.lang.String inProcHandle,
                                    java.lang.Object... params)
```
    Invoke an internal procedure with the specified name.
    
    Parameters:
    
    procedure - The internal procedure name.
    
    inProcHandle - the parent procedure handle converted with handle.toString()
    
    params - The parameters.
    
    Returns:
    
    A response holding the RETURN-VALUE for this procedure call.
  - deleteHandle
```
void deleteHandle(long handleId,
                  boolean noError)
```
    Delete the resource associated with the specified handle.
    
    Parameters:
    
    handleId - The handle ID of the resource.
    
    noError - true to process using silent error mode.
  - subscribeExternal
```
long subscribeExternal(boolean global,
                       java.lang.Long subscriber,
                       java.lang.String event,
                       java.lang.Long publisher,
                       boolean noError)
```
    Create a new subscription to the given event for a specified external resource. This resource will receive a notification when the event is published.
    
    Parameters:
    
    global - Flag indicating if the subscription is for global (cross-session) events.
    
    subscriber - The resource to notify when the specified event is published. If null, a ExternalResource will be built and its ID return.
    
    event - The name of the event which is being published.
    
    publisher - The handle representing the program or resource that is the source of the event. If specified, the named event will only cause a notification if the event source matches this handle. null represents the ANYWHERE option which means that the events will not be filtered by source.
    
    noError - true to process using silent error mode.
    
    Returns:
    
    The subscriber's ID.
  - unsubscribeExternal
```
void unsubscribeExternal(boolean global,
                         java.lang.Long subscriber,
                         java.lang.String event,
                         java.lang.Long publisher)
```
    Delete a subscription to the given event for the specified external resource. This method is
    All processing is done with silent error mode implicitly enabled.
    
    Parameters:
    
    global - Flag indicating if the search is done in the global (cross-session) event register.
    
    subscriber - The resource whose subscription is to be deleted. Must not be null.
    
    event - The name of the event which is being published. If this is null, then subscriptions to all events will be deleted.
    
    publisher - The procedure or resource handle representing the source of the event. If specified, the subscription will only be deleted if the event source matches this handle. null represents the ALL option which means that the events will not be filtered by source. When null, it means that the publisher was not set.
  - publishExternal
```
void publishExternal(java.lang.String event,
                     long publisher,
                     java.lang.String[] args)
```
    Notify all subscribers (to the given event) that the event has occurred.
    All processing is done with silent error mode implicitly enabled.
    The subscriptions are fired in the order they were subscribed. Although 4GL documentation specifically states, that "If a named event has multiple subscribers, the order in which the AVM notifies subscribers is undefined.", the actual 4GL implementation (OpenEdge 10.2B) does fire the events in the order the subscriptions get subscribed.
    
    Parameters:
    
    event - The name of the event which is being published.
    
    publisher - The procedure or resource handle representing the program that is the source of the event. Must not be null.
    
    args - The parameters passed to the subscriber. May be null to represent no parameters. When null, it means that no parameters were specified for this call.
  - createExternal
```
long createExternal()
```
    Create an external resource to be used by a remote, non P2J, side.
    
    Returns:
    
    The resource id.
  - resetWaitState
```
void resetWaitState()
```
    Resets wait-state previously set by LogicalTerminal.setWaitState(String).
    This method should not be called from the server.
    The purpose of the method is to provide a callback mechanism for the client when wait-state is reset due to UI flow (i.e. when a modal window is shown). This is also the reason the method doesn't perform a down-call to the client.
  - openHyperlink
```
void openHyperlink(int columnWidgetId,
                   java.lang.String hyperlinkText)
```
    Open the hyperlink in the browse column by raising the event previously set for this column using the HYPERLINK attribute (FWD extension). hyperlinkText is used as the event parameter. I.e. opening of a hyperlink is an equivalent of
    PUBLISH eventName (hyperlinkText).
    
    Parameters:
    
    columnWidgetId - ID of the target browse column widget.
    
    hyperlinkText - Text of the hyperlink to be opened.
  - setDynamicSorting
```
void setDynamicSorting(int browseId,
                       int[] columnOrdinals,
                       boolean[] ascending)
```
    Set dynamic sorting for the browse.
    
    Parameters:
    
    browseId - ID of the browse which should handle the request.
    
    columnOrdinals - Array of the ordinals of the sort columns. Inside the array ordinals are positioned from the column which defines the most coarse sorting to the most granular.
    
    ascending - Array of the sorting directions of the sort columns. true for ascending, false for descending. Inside the array directions are positioned from the column which defines the most coarse sorting to the most granular.
  - setDynamicFiltering
```
void setDynamicFiltering(int browseId,
                         int[] columnOrdinals,
                         BaseDataType[] values)
```
    Set dynamic filtering for the browse.
    
    Parameters:
    
    browseId - ID of the browse which should handle the request.
    
    columnOrdinals - Array of the ordinals of the filtered columns.
    
    values - Array of the filter values for the filtered columns..
  - messageBlasterEvent
```
void messageBlasterEvent(long id,
                         int msgVal,
                         int wParam,
                         int lParam,
                         int lplRetVal)
```
    Sends a MessageBlaster notification back to server.
    
    Parameters:
    
    id - The id of the MessageBlaster instance.
    
    msgVal - The message id. Should be one already added to msgList.
    
    wParam - Message parameter 1.
    
    lParam - Message parameter 2.
    
    lplRetVal - Message parameter / return value.
  - readHtmlBrowserWhitelist
```
java.util.Map<java.lang.String,java.net.URI> readHtmlBrowserWhitelist()
```
    Retrieve all local paths whitelisted as resource-base for html web browser.
    
    Returns:
    
    The whtielist of resource-base.
  - setClientMetrics
```
void setClientMetrics(ClientMetrics metrics)
```
    Sets the client metrics in the current session.
    
    Parameters:
    
    metrics - The metrics instance.
  - getCustomFontData
```
java.util.Map<java.lang.String,byte[]> getCustomFontData()
```
    Returns font data in a form of map where key is the lower-cased name as defined in server directory "custom-font" container and map value is the raw file data of respective font files. For bold font entries (node "bold" set to true) the key has the form <lower-cased font name>#true, otherwise the key has the form <lower-cased font name>#false. The caller must not modify the byte array map values.
    
    Returns:
    
    See above.
  - emitComEvent
```
ServerReturnValue emitComEvent(int widgetId,
                               java.lang.String eventName,
                               BaseDataType... args)
```
    Emits the supplied COM event.
    
    Parameters:
    
    widgetId - Id of the widget that will become the source of the emitted event.
    
    eventName - Event name.
    
    args - Event arguments.
    
    Returns:
    
    A container including the array of all output arguments produced by the event, if any.
  - requestNodeExpand
```
void requestNodeExpand(int treeWidgetId,
                       int nodeId,
                       boolean expand,
                       boolean allChildren)
```
    Clients use this method to request node expansion status change.
    
    Parameters:
    
    treeWidgetId - the tree widget ID.
    
    nodeId - the node ID.
    
    expand - the new expansion status.
    
    allChildren - all child nodes to be involved or direct childs only.
  - forkNewSession
```
void forkNewSession()
```
    Creates a new session forked from the current one.
  - sortTreeList
```
void sortTreeList(int widgetId,
                  int index,
                  boolean resetSorting)
```
    Sorts a tree list widget by a column.
    
    Parameters:
    
    widgetId - the ID of the tree list
    
    index - the index of the column being sorted
    
    resetSorting - if true, then reset column sorting
  - endSpreadsheetBatch
```
void endSpreadsheetBatch(int contextId)
```
    Ends the current batch of spreadsheet commands.
    
    Parameters:
    
    contextId - the ID of the spreadsheet web app context to end the batch for

Interface ServerExports

Method Summary

Method Detail

invokeServerEvent

validResource

getResourceIdByWidgetId

trigger

validate

help

refresh

getEditorsConfigs

getRowCount

getRowCount

getRows

getRows

updateRow

setCurrentRow

getCurrentRow

isRowAvailable

runReport

getEnhancedBrowseSaveTargets

getColumnFiltersMappedDataTypes

getEnhancedBrowseResetTargets

resetEnhancedConfig

applyEnhancedConfig

saveOrCacheEnhancedConfig

moveColumnServer

notifyBrowseLayoutPerformed

readResponseEvent

connectEvent

createSocket

getRequiredTheme

getThemes

isOldBrowseSelectionBar

getUploadFileSizeLimits

getGuiSubMenuDelay

getForceDialogsInCenter

isBypassDefaultWindowShowInPauseNoMessage

readSystemFontTable

readFontTable

setThemePreferredFonts

readDefaultFonts

getKeyboardLayoutsSettings

getHTMLBrowserLoadTimeout

getSupportedHelperApplications

getLegacyTextMetrics

readLegacyTextMetrics

readColorTable

readSystemColorTable

loadEnvironment

getSessionTooltips

refreshBuffers

getProgressStackTrace

invoke

invokeProcedure

invokeInProcedure

deleteHandle

subscribeExternal

unsubscribeExternal

publishExternal

createExternal

resetWaitState

openHyperlink

setDynamicSorting

setDynamicFiltering

messageBlasterEvent

readHtmlBrowserWhitelist

setClientMetrics

getCustomFontData

emitComEvent

requestNodeExpand

forkNewSession

sortTreeList

endSpreadsheetBatch