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

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

```
public class ConfigHelper
extends java.lang.Object
```
The class contains methods implementing elementary logic around the BaseConfig fields.

Constructor Summary

Constructors
Constructor and Description

ConfigHelper()

Constructors
Constructor and Description
`ConfigHelper()`

Method Summary

All Methods Static Methods Concrete Methods
Modifier and Type	Method and Description
`static double`	`getAssignedColumn(BaseConfig cfg)` Returns the initial or set COLUMN value from the passed config instance.
`static Point`	`getAssignedLocation(BaseConfig cfg)` The returned value represents the location value assigned in frame definition or as set by COLUMN/ROW attributes.
`static NativePoint`	`getAssignedPixelLocation(BaseConfig cfg)` The returned value represents the location value assigned in frame definition or as set by X/Y attributes.
`static double`	`getAssignedRow(BaseConfig cfg)` Returns the initial or set ROW value from the passed config instance.
`static int`	`getAssignedX(BaseConfig cfg)` Returns the initial or set X value from the passed config instance.
`static int`	`getAssignedY(BaseConfig cfg)` Returns the initial or set Y value from the passed config instance.
`static double`	`getColon(BaseConfig cfg)` Get COLON attribute value from the passed configuration.
`static double`	`getEffectiveColumn(BaseConfig cfg)` Returns the effective COLUMN value from the passed config instance.
`static Dimension`	`getEffectiveDimension(BaseConfig cfg)` The returned value represents the actual widget dimension as rendered on the client.
`static double`	`getEffectiveHeight(BaseConfig cfg)` Returns the effective HEIGHT-CHARS value from the passed config instance.
`static int`	`getEffectiveHeightPixels(BaseConfig cfg)` Returns the effective HEIGHT-PIXELS value from the passed config instance.
`static Point`	`getEffectiveLocation(BaseConfig cfg)` The returned value represents the actual widget location as rendered on the client.
`static NativePoint`	`getEffectivePixelLocation(BaseConfig cfg)` The returned value represents the actual widget location as rendered on the client.
`static double`	`getEffectiveRow(BaseConfig cfg)` Returns the effective ROW value from the passed config instance.
`static double`	`getEffectiveVirtualHeight(PaneConfig cfg)` Returns the effective frame virtual size from the supplied pane config.
`static int`	`getEffectiveVirtualHeightPixels(PaneConfig cfg)` Returns the effective frame virtual size from the supplied pane config.
`static double`	`getEffectiveVirtualWidth(PaneConfig cfg)` Returns the effective frame virtual size from the supplied pane config.
`static int`	`getEffectiveVirtualWidthPixels(PaneConfig cfg)` Returns the effective frame virtual size from the supplied pane config.
`static double`	`getEffectiveWidth(BaseConfig cfg)` Returns the effective WIDTH-CHARS value from the passed config instance.
`static int`	`getEffectiveWidthPixels(BaseConfig cfg)` Returns the effective WIDTH-PIXELS value from the passed config instance.
`static int`	`getEffectiveX(BaseConfig cfg)` Returns the effective X value from the passed config instance.
`static int`	`getEffectiveY(BaseConfig cfg)` Returns the effective Y value from the passed config instance.
`static double`	`getInitialColumn(BaseConfig cfg)` Returns the initial COLUMN value from the passed config instance.
`static Point`	`getInitialLocation(BaseConfig cfg)` The returned value represents the location value assigned in frame definition.
`static NativePoint`	`getInitialPixelLocation(BaseConfig cfg)` The returned value represents the location value assigned in frame definition.
`static double`	`getInitialRow(BaseConfig cfg)` Returns the initial ROW value from the passed config instance.
`static int`	`getInitialX(BaseConfig cfg)` Returns the initial X value from the passed config instance.
`static int`	`getInitialY(BaseConfig cfg)` Returns the initial Y value from the passed config instance.
`static double`	`getMaxHeightChars(WindowConfig cfg)` An accessor method to get the value of MAX-HEIGHT-CHARS attribute from the supplied config.
`static int`	`getMaxHeightPixels(WindowConfig cfg)` An accessor method to get the value of MAX-HEIGHT-PIXELS attribute from the supplied config.
`static double`	`getMaxWidthChars(WindowConfig cfg)` An accessor method to get the value of MAX-WIDTH-CHARS attribute from the supplied config.
`static int`	`getMaxWidthPixels(WindowConfig cfg)` An accessor method to get the value of MAX-WIDTH-PIXELS attribute from the supplied config.
`static double`	`getMinHeightChars(WindowConfig cfg)` An accessor method to get the value of MIN-HEIGHT-CHARS attribute from the supplied config.
`static int`	`getMinHeightPixels(WindowConfig cfg)` An accessor method to get the value of MIN-HEIGHT-PIXELS attribute from the supplied config.
`static double`	`getMinWidthChars(WindowConfig cfg)` An accessor method to get the value of MIN-WIDTH-CHARS attribute from the supplied config.
`static int`	`getMinWidthPixels(WindowConfig cfg)` An accessor method to get the value of MIN-WIDTH-PIXELS attribute from the supplied config.
`static double`	`getTo(BaseConfig cfg)` Get COLON attribute value from the passed configuration.
`static byte`	`getWindowState(WindowConfig cfg)` Returns the effective window state.
`static boolean`	`isLeftAligned(BaseConfig cfg)` Check if widget is left aligned.
`static void`	`setColon(BaseConfig cfg, double colon)` Set COLON attribute value in the passed configuration.
`static void`	`setModified(WidgetConfig cfg, boolean modified)` Set new value to the MODIFIED attribute in the passed configuration.
`static void`	`setTo(BaseConfig cfg, double value)` Sets the rightmost column of the widget in the passed configuration.

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

- Constructor Detail
  - ConfigHelper
```
public ConfigHelper()
```
- Method Detail
  - getEffectiveColumn
```
public static double getEffectiveColumn(BaseConfig cfg)
```
    Returns the effective COLUMN value from the passed config instance. The returned value represents the actual widget location as rendered on the client.
    
    Parameters:
    
    cfg - A valid BaseConfig reference.
    
    Returns:
    
    COLUMN character value.
  - getEffectiveRow
```
public static double getEffectiveRow(BaseConfig cfg)
```
    Returns the effective ROW value from the passed config instance. The returned value represents the actual widget location as rendered on the client.
    
    Parameters:
    
    cfg - A valid BaseConfig reference.
    
    Returns:
    
    ROW character value.
  - getEffectiveLocation
```
public static Point getEffectiveLocation(BaseConfig cfg)
```
    The returned value represents the actual widget location as rendered on the client.
    
    Parameters:
    
    cfg - A valid BaseConfig reference.
    
    Returns:
    
    A valid Point reference.
  - getEffectiveWidth
```
public static double getEffectiveWidth(BaseConfig cfg)
```
    Returns the effective WIDTH-CHARS value from the passed config instance. The returned value represents the actual widget width as rendered on the client.
    
    Parameters:
    
    cfg - A valid BaseConfig reference.
    
    Returns:
    
    WIDTH-CHARS character value.
  - getEffectiveHeight
```
public static double getEffectiveHeight(BaseConfig cfg)
```
    Returns the effective HEIGHT-CHARS value from the passed config instance. The returned value represents the actual widget location as rendered on the client.
    
    Parameters:
    
    cfg - A valid BaseConfig reference.
    
    Returns:
    
    HEIGHT-CHARS character value.
  - getEffectiveWidthPixels
```
public static int getEffectiveWidthPixels(BaseConfig cfg)
```
    Returns the effective WIDTH-PIXELS value from the passed config instance. The returned value represents the actual widget width as rendered on the client.
    
    Parameters:
    
    cfg - A valid BaseConfig reference.
    
    Returns:
    
    WIDTH-PIXELS value.
  - getEffectiveHeightPixels
```
public static int getEffectiveHeightPixels(BaseConfig cfg)
```
    Returns the effective HEIGHT-PIXELS value from the passed config instance. The returned value represents the actual widget location as rendered on the client.
    
    Parameters:
    
    cfg - A valid BaseConfig reference.
    
    Returns:
    
    HEIGHT-PIXELS value.
  - getEffectiveDimension
```
public static Dimension getEffectiveDimension(BaseConfig cfg)
```
    The returned value represents the actual widget dimension as rendered on the client.
    
    Parameters:
    
    cfg - A valid BaseConfig reference.
    
    Returns:
    
    A valid Dimension reference.
  - getEffectiveX
```
public static int getEffectiveX(BaseConfig cfg)
```
    Returns the effective X value from the passed config instance. The returned value represents the actual widget location as rendered on the client.
    
    Parameters:
    
    cfg - A valid BaseConfig reference.
    
    Returns:
    
    X coordinate value.
  - getEffectiveY
```
public static int getEffectiveY(BaseConfig cfg)
```
    Returns the effective Y value from the passed config instance. The returned value represents the actual widget location as rendered on the client.
    
    Parameters:
    
    cfg - A valid BaseConfig reference.
    
    Returns:
    
    Y coordinate value.
  - getEffectivePixelLocation
```
public static NativePoint getEffectivePixelLocation(BaseConfig cfg)
```
    The returned value represents the actual widget location as rendered on the client.
    
    Parameters:
    
    cfg - A valid BaseConfig reference.
    
    Returns:
    
    A valid NativePoint reference.
  - getInitialColumn
```
public static double getInitialColumn(BaseConfig cfg)
```
    Returns the initial COLUMN value from the passed config instance. The returned value represents the value assigned in frame definition.
    
    Parameters:
    
    cfg - A valid BaseConfig reference.
    
    Returns:
    
    COLUMN character value.
  - getInitialRow
```
public static double getInitialRow(BaseConfig cfg)
```
    Returns the initial ROW value from the passed config instance. The returned value represents the value assigned in frame definition.
    
    Parameters:
    
    cfg - A valid BaseConfig reference.
    
    Returns:
    
    ROW character value.
  - getInitialLocation
```
public static Point getInitialLocation(BaseConfig cfg)
```
    The returned value represents the location value assigned in frame definition.
    
    Parameters:
    
    cfg - A valid BaseConfig reference.
    
    Returns:
    
    A valid Point reference.
  - getInitialX
```
public static int getInitialX(BaseConfig cfg)
```
    Returns the initial X value from the passed config instance. The returned value represents the value assigned in frame definition.
    
    Parameters:
    
    cfg - A valid BaseConfig reference.
    
    Returns:
    
    X coordinate value.
  - getInitialY
```
public static int getInitialY(BaseConfig cfg)
```
    Returns the initial Y value from the passed config instance. The returned value represents the value assigned in frame definition.
    
    Parameters:
    
    cfg - A valid BaseConfig reference.
    
    Returns:
    
    Y coordinate value.
  - getInitialPixelLocation
```
public static NativePoint getInitialPixelLocation(BaseConfig cfg)
```
    The returned value represents the location value assigned in frame definition.
    
    Parameters:
    
    cfg - A valid BaseConfig reference.
    
    Returns:
    
    A valid NativePoint reference.
  - getAssignedColumn
```
public static double getAssignedColumn(BaseConfig cfg)
```
    Returns the initial or set COLUMN value from the passed config instance. The returned value represents the value assigned in frame definition or as set by COLUMN attribute.
    
    Parameters:
    
    cfg - A valid BaseConfig reference.
    
    Returns:
    
    COLUMN character value.
  - getAssignedRow
```
public static double getAssignedRow(BaseConfig cfg)
```
    Returns the initial or set ROW value from the passed config instance. The returned value represents the value assigned in frame definition or as set by ROW attribute.
    
    Parameters:
    
    cfg - A valid BaseConfig reference.
    
    Returns:
    
    ROW character value.
  - getAssignedLocation
```
public static Point getAssignedLocation(BaseConfig cfg)
```
    The returned value represents the location value assigned in frame definition or as set by COLUMN/ROW attributes.
    
    Parameters:
    
    cfg - A valid BaseConfig reference.
    
    Returns:
    
    A valid Point reference.
  - getAssignedX
```
public static int getAssignedX(BaseConfig cfg)
```
    Returns the initial or set X value from the passed config instance. The returned value represents the value assigned in frame definition or as set by X attribute.
    
    Parameters:
    
    cfg - A valid BaseConfig reference.
    
    Returns:
    
    X pixel value.
  - getAssignedY
```
public static int getAssignedY(BaseConfig cfg)
```
    Returns the initial or set Y value from the passed config instance. The returned value represents the value assigned in frame definition or as set by Y attribute.
    
    Parameters:
    
    cfg - A valid BaseConfig reference.
    
    Returns:
    
    Y pixel value.
  - getAssignedPixelLocation
```
public static NativePoint getAssignedPixelLocation(BaseConfig cfg)
```
    The returned value represents the location value assigned in frame definition or as set by X/Y attributes.
    
    Parameters:
    
    cfg - A valid BaseConfig reference.
    
    Returns:
    
    A valid NativePoint reference.
  - isLeftAligned
```
public static boolean isLeftAligned(BaseConfig cfg)
```
    Check if widget is left aligned.
    
    Parameters:
    
    cfg - Widget config.
    
    Returns:
    
    true if widget is left aligned.
  - getTo
```
public static double getTo(BaseConfig cfg)
```
    Get COLON attribute value from the passed configuration. Note that Progress does not have corresponding attribute accessible to program.
    
    Parameters:
    
    cfg - A valid BaseConfig instance.
    
    Returns:
    
    Current attribute value.
  - setTo
```
public static void setTo(BaseConfig cfg,
                         double value)
```
    Sets the rightmost column of the widget in the passed configuration. This method must be called only on the server.
    
    Parameters:
    
    cfg - A valid BaseConfig instance.
    
    value - The 0-based column number.
  - getColon
```
public static double getColon(BaseConfig cfg)
```
    Get COLON attribute value from the passed configuration. Note that Progress does not have corresponding attribute accessible to program.
    
    Parameters:
    
    cfg - A valid BaseConfig instance.
    
    Returns:
    
    Current attribute value.
  - setColon
```
public static void setColon(BaseConfig cfg,
                            double colon)
```
    Set COLON attribute value in the passed configuration. Note that Progress does not have corresponding attribute accessible to program. This method must be called only on the server.
    
    Parameters:
    
    cfg - A valid BaseConfig instance.
    
    colon - New value for the attribute.
  - setModified
```
public static void setModified(WidgetConfig cfg,
                               boolean modified)
```
    Set new value to the MODIFIED attribute in the passed configuration.
    
    Parameters:
    
    cfg - A valid BaseConfig instance.
    
    modified - New value for the attribute.
  - getMaxWidthChars
```
public static double getMaxWidthChars(WindowConfig cfg)
```
    An accessor method to get the value of MAX-WIDTH-CHARS attribute from the supplied config.
    
    Parameters:
    
    cfg - A reference to WindowConfig.
    
    Returns:
    
    See above.
  - getMaxHeightChars
```
public static double getMaxHeightChars(WindowConfig cfg)
```
    An accessor method to get the value of MAX-HEIGHT-CHARS attribute from the supplied config.
    
    Parameters:
    
    cfg - A reference to WindowConfig.
    
    Returns:
    
    See above.
  - getMaxWidthPixels
```
public static int getMaxWidthPixels(WindowConfig cfg)
```
    An accessor method to get the value of MAX-WIDTH-PIXELS attribute from the supplied config.
    
    Parameters:
    
    cfg - A reference to WindowConfig.
    
    Returns:
    
    See above.
  - getMaxHeightPixels
```
public static int getMaxHeightPixels(WindowConfig cfg)
```
    An accessor method to get the value of MAX-HEIGHT-PIXELS attribute from the supplied config.
    
    Parameters:
    
    cfg - A reference to WindowConfig.
    
    Returns:
    
    See above.
  - getMinWidthChars
```
public static double getMinWidthChars(WindowConfig cfg)
```
    An accessor method to get the value of MIN-WIDTH-CHARS attribute from the supplied config.
    
    Parameters:
    
    cfg - A reference to WindowConfig.
    
    Returns:
    
    See above.
  - getMinHeightChars
```
public static double getMinHeightChars(WindowConfig cfg)
```
    An accessor method to get the value of MIN-HEIGHT-CHARS attribute from the supplied config.
    
    Parameters:
    
    cfg - A reference to WindowConfig.
    
    Returns:
    
    See above.
  - getMinWidthPixels
```
public static int getMinWidthPixels(WindowConfig cfg)
```
    An accessor method to get the value of MIN-WIDTH-PIXELS attribute from the supplied config.
    
    Parameters:
    
    cfg - A reference to WindowConfig.
    
    Returns:
    
    See above.
  - getMinHeightPixels
```
public static int getMinHeightPixels(WindowConfig cfg)
```
    An accessor method to get the value of MIN-HEIGHT-PIXELS attribute from the supplied config.
    
    Parameters:
    
    cfg - A reference to WindowConfig.
    
    Returns:
    
    See above.
  - getEffectiveVirtualWidth
```
public static double getEffectiveVirtualWidth(PaneConfig cfg)
```
    Returns the effective frame virtual size from the supplied pane config.
    
    Parameters:
    
    cfg - A reference to PaneConfig.
    
    Returns:
    
    See above.
  - getEffectiveVirtualHeight
```
public static double getEffectiveVirtualHeight(PaneConfig cfg)
```
    Returns the effective frame virtual size from the supplied pane config.
    
    Parameters:
    
    cfg - A reference to PaneConfig.
    
    Returns:
    
    See above.
  - getEffectiveVirtualWidthPixels
```
public static int getEffectiveVirtualWidthPixels(PaneConfig cfg)
```
    Returns the effective frame virtual size from the supplied pane config.
    
    Parameters:
    
    cfg - A reference to PaneConfig.
    
    Returns:
    
    See above.
  - getEffectiveVirtualHeightPixels
```
public static int getEffectiveVirtualHeightPixels(PaneConfig cfg)
```
    Returns the effective frame virtual size from the supplied pane config.
    
    Parameters:
    
    cfg - A reference to PaneConfig.
    
    Returns:
    
    See above.
  - getWindowState
```
public static byte getWindowState(WindowConfig cfg)
```
    Returns the effective window state. The method takes part of the WINDOW-STATE attribute runtime support.
    
    Parameters:
    
    cfg - Window config.
    
    Returns:
    
    See above.

Class ConfigHelper

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

ConfigHelper

Method Detail

getEffectiveColumn

getEffectiveRow

getEffectiveLocation

getEffectiveWidth

getEffectiveHeight

getEffectiveWidthPixels

getEffectiveHeightPixels

getEffectiveDimension

getEffectiveX

getEffectiveY

getEffectivePixelLocation

getInitialColumn

getInitialRow

getInitialLocation

getInitialX

getInitialY

getInitialPixelLocation

getAssignedColumn

getAssignedRow

getAssignedLocation

getAssignedX

getAssignedY

getAssignedPixelLocation

isLeftAligned

getTo

setTo

getColon

setColon

setModified

getMaxWidthChars

getMaxHeightChars

getMaxWidthPixels

getMaxHeightPixels

getMinWidthChars

getMinHeightChars

getMinWidthPixels

getMinHeightPixels

getEffectiveVirtualWidth

getEffectiveVirtualHeight

getEffectiveVirtualWidthPixels

getEffectiveVirtualHeightPixels

getWindowState