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

java.lang.Object
- com.goldencode.p2j.ui.ScreenDefinition

All Implemented Interfaces:

java.io.Externalizable, java.io.Serializable
```
public class ScreenDefinition
extends java.lang.Object
implements java.io.Externalizable
```
This is a container for the configuration of a given frame or family of frames which is efficiently serialized to the client from the server.

See Also:

Serialized Form

Field Summary

Fields
Modifier and Type	Field and Description
`private int`	`id` Root frame ID.
`private java.util.Map<java.lang.Integer,java.lang.Integer>`	`sideLabelParents` For each side-label, specify its parent.
`private java.util.Map<java.lang.Integer,WidgetConfig>`	`sideLabels` Map with the registered side-labels in this frame.
`private boolean`	`suppressRedraw` Suppress redraw on push of screen definition.
`private java.util.LinkedHashMap<java.lang.Integer,WidgetConfig>`	`widgets` The widget configuration data.

Constructor Summary

Constructors
Constructor and Description
`ScreenDefinition()` Default constructor (only used for serialization).
`ScreenDefinition(int id)` The constructor creates a screen definition with the given root frame ID.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addConfig(WidgetConfig config)` Add a widget configuration to the current screen definition.
`void`	`addConfig(WidgetConfig config, int widgetID)` Add a widget configuration (to the current screen definition) and assign that widget the specified ID.
`private void`	`addConfigInt(WidgetConfig config)` Common worker to add a widget configuration to the screen definition.
`void`	`addSideLabel(int sideLabelId, int widgetId)` Add a new side-label and associate it with the given widget.
`boolean`	`containsSideLabel(int widgetId)` Returns `true` when the the screen side label ids contain the supplied widget id, `false` otherwise.
`boolean`	`containsWidget(int widgetId)` Returns `true` when the the screen definition widget ids contain the supplied widget id, `false` otherwise.
`WidgetConfig`	`getConfig(int id)` Gets a specific widget configuration instance for the widget with the ID provided.
`java.util.Iterator<WidgetConfig>`	`getConfigsIterator()` Get an iterator to enumerate all widget configurations inside this screen definition.
`int`	`getRootFrameID()` Get the root frame ID.
`int`	`getSideLabelParent(int sideLabelId)` Get the parent widget for the given side-label.
`java.util.Iterator<WidgetConfig>`	`getSideLabelsIterator()` Get an iterator to enumerate all widget configurations inside this screen definition.
`java.util.ArrayList<java.lang.Integer>`	`getWidgetsInFrame(int frameId)` Gets an array of all widget IDs in a given frame including any child frames.
`boolean`	`isSideLabel(int widgetId)` Check if the given widget ID is for a side-label.
`boolean`	`isSuppressRedraw()` Get current value of 'suppress redraw' flag.
`void`	`readExternal(java.io.ObjectInput in)` Replacement for the default object reading method.
`void`	`removeConfig(WidgetConfig config)` Removes a widget configuration from the current screen definition.
`void`	`setSuppressRedraw(boolean suppressRedraw)` Set new value for 'suppress redraw' flag.
`void`	`writeExternal(java.io.ObjectOutput out)` Replacement for the default object writing method.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - widgets
```
private java.util.LinkedHashMap<java.lang.Integer,WidgetConfig> widgets
```
    The widget configuration data.
  - id
```
private int id
```
    Root frame ID.
  - suppressRedraw
```
private boolean suppressRedraw
```
    Suppress redraw on push of screen definition.
  - sideLabels
```
private java.util.Map<java.lang.Integer,WidgetConfig> sideLabels
```
    Map with the registered side-labels in this frame.
  - sideLabelParents
```
private java.util.Map<java.lang.Integer,java.lang.Integer> sideLabelParents
```
    For each side-label, specify its parent.
- Constructor Detail
  - ScreenDefinition
```
public ScreenDefinition()
```
    Default constructor (only used for serialization).
  - ScreenDefinition
```
public ScreenDefinition(int id)
```
    The constructor creates a screen definition with the given root frame ID.
    
    Parameters:
    
    id - Identifies the root frame (or the only frame if this is not going to hold the configuration of a frame family).
- Method Detail
  - getRootFrameID
```
public int getRootFrameID()
```
    Get the root frame ID.
    
    Returns:
    
    The root frame ID.
  - getWidgetsInFrame
```
public java.util.ArrayList<java.lang.Integer> getWidgetsInFrame(int frameId)
```
    Gets an array of all widget IDs in a given frame including any child frames.
    
    Parameters:
    
    frameId - ID of the frame for which widget IDs are requested.
    
    Returns:
    
    The list of all widget IDs for the specified frame.
  - getConfigsIterator
```
public java.util.Iterator<WidgetConfig> getConfigsIterator()
```
    Get an iterator to enumerate all widget configurations inside this screen definition.
    
    Returns:
    
    The iterator.
  - getSideLabelsIterator
```
public java.util.Iterator<WidgetConfig> getSideLabelsIterator()
```
    Get an iterator to enumerate all widget configurations inside this screen definition.
    
    Returns:
    
    The iterator.
  - containsWidget
```
public boolean containsWidget(int widgetId)
```
    Returns true when the the screen definition widget ids contain the supplied widget id, false otherwise.
    
    Parameters:
    
    widgetId - Widget id to check.
    
    Returns:
    
    See above.
  - containsSideLabel
```
public boolean containsSideLabel(int widgetId)
```
    Returns true when the the screen side label ids contain the supplied widget id, false otherwise.
    
    Parameters:
    
    widgetId - Widget id to check.
    
    Returns:
    
    See above.
  - getConfig
```
public WidgetConfig getConfig(int id)
```
    Gets a specific widget configuration instance for the widget with the ID provided.
    
    Parameters:
    
    id - The widget ID.
    
    Returns:
    
    The requested widget configuration object if exists, null otherwise.
  - addConfig
```
public void addConfig(WidgetConfig config)
```
    Add a widget configuration to the current screen definition.
    
    Parameters:
    
    config - New config to be added to the current screen definition.
  - addConfig
```
public void addConfig(WidgetConfig config,
                      int widgetID)
```
    Add a widget configuration (to the current screen definition) and assign that widget the specified ID.
    
    Parameters:
    
    config - New config to be added to the current screen definition.
    
    widgetID - Widget ID.
  - removeConfig
```
public void removeConfig(WidgetConfig config)
```
    Removes a widget configuration from the current screen definition.
    
    Parameters:
    
    config - The config to be removed from the current screen definition.
  - readExternal
```
public void readExternal(java.io.ObjectInput in)
                  throws java.io.IOException,
                         java.lang.ClassNotFoundException
```
    Replacement for the default object reading method. The latest state is read from the input source.
    
    Specified by:
    
    readExternal in interface java.io.Externalizable
    
    Parameters:
    
    in - The input source from which fields will be restored.
    
    Throws:
    
    java.io.IOException - In case of I/O errors.
    
    java.lang.ClassNotFoundException - If payload can't be instantiated.
  - writeExternal
```
public void writeExternal(java.io.ObjectOutput out)
                   throws java.io.IOException
```
    Replacement for the default object writing method. The latest state is written to the output destination.
    
    Specified by:
    
    writeExternal in interface java.io.Externalizable
    
    Parameters:
    
    out - The output destination to which fields will be saved.
    
    Throws:
    
    java.io.IOException - In case of I/O errors.
  - setSuppressRedraw
```
public void setSuppressRedraw(boolean suppressRedraw)
```
    Set new value for 'suppress redraw' flag.
    
    Parameters:
    
    suppressRedraw - New value of flag.
  - isSuppressRedraw
```
public boolean isSuppressRedraw()
```
    Get current value of 'suppress redraw' flag.
    
    Returns:
    
    The current value of the flag.
  - addSideLabel
```
public void addSideLabel(int sideLabelId,
                         int widgetId)
```
    Add a new side-label and associate it with the given widget.
    
    Parameters:
    
    sideLabelId - The label's ID.
    
    widgetId - The ID of the widget to which this label belongs.
  - isSideLabel
```
public boolean isSideLabel(int widgetId)
```
    Check if the given widget ID is for a side-label.
    
    Parameters:
    
    widgetId - The widget ID to be checked.
    
    Returns:
    
    true if the sideLabels maps contains an entry for this widget ID.
  - getSideLabelParent
```
public int getSideLabelParent(int sideLabelId)
```
    Get the parent widget for the given side-label.
    
    Parameters:
    
    sideLabelId - The ID of the side label.
    
    Returns:
    
    The parent widget ID, as contained in the sideLabelParents map.
  - addConfigInt
```
private void addConfigInt(WidgetConfig config)
```
    Common worker to add a widget configuration to the screen definition.
    
    Parameters:
    
    config - Widget configuration.

Class ScreenDefinition

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

widgets

id

suppressRedraw

sideLabels

sideLabelParents

Constructor Detail

ScreenDefinition

ScreenDefinition

Method Detail

getRootFrameID

getWidgetsInFrame

getConfigsIterator

getSideLabelsIterator

containsWidget

containsSideLabel

getConfig

addConfig

addConfig

removeConfig

readExternal

writeExternal

setSuppressRedraw

isSuppressRedraw

addSideLabel

isSideLabel

getSideLabelParent

addConfigInt