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

All Superinterfaces:

IterableResource

All Known Subinterfaces:

HandleCommon

All Known Implementing Classes:

FrameWidget
```
public interface FrameInterface
extends IterableResource
```
Define all FRAME-specific widget attributes and methods which can be accessed via a handle instance. Attributes and methods shared by multiple widget types will be defined elsewhere.

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`handle`	`backgroundIteration()` Get the handle for the background iteration of the frame.
`decimal`	`borderBottomChars()` Get the thickness (in character units) of the border at the bottom of the frame or dialog box.
`integer`	`borderBottomPixels()` Get the thickness (in pixels) of the border at the bottom of the frame or dialog box.
`decimal`	`borderLeftChars()` Get the thickness (in character units) of the border at the left of the frame or dialog box.
`integer`	`borderLeftPixels()` Get the thickness (in pixels) of the border at the left of the frame or dialog box.
`decimal`	`borderRightChars()` Get the thickness (in character units) of the border at the right of the frame or dialog box.
`integer`	`borderRightPixels()` Get the thickness (in pixels) of the border at the right of the frame or dialog box.
`decimal`	`borderTopChars()` Get the thickness (in character units) of the border at the top of the frame or dialog box.
`integer`	`borderTopPixels()` Get the thickness (in pixels) of the border at the top of the frame or dialog box.
`handle`	`getCancelButton()` Gets the cancel button for this frame.
`handle`	`getDefaultButton()` Get the default button of this frame.
`logical`	`isCarefulPaint()` Get the CAREFUL-PAINT attribute.
`logical`	`isCentered()` Get the value of the CENTERED attribute which defines if the frame is to be centered in the width of the parent window.
`logical`	`isOverlay()` Get the value of the OVERLAY attribute which means that the frame can overlay other frames on the display.
`logical`	`isSideLabels()` Get the SIDE-LABELS attribute.
`integer`	`line()` Get the current iteration number for down frame.
`void`	`setCancelButton(handle cancelButton)` Sets the cancel button for this frame.
`void`	`setCarefulPaint(boolean careful)` Sets the CAREFUL-PAINTattribute.
`void`	`setCarefulPaint(logical careful)` Sets the CAREFUL-PAINTattribute.
`void`	`setCentered(boolean center)` Set the value of the CENTERED attribute which defines if the frame is to be centered in the width of the parent window.
`void`	`setCentered(logical center)` Set the value of the CENTERED attribute which defines if the frame is to be centered in the width of the parent window.
`void`	`setDefaultButton(handle defButton)` Set the default button of this frame.
`void`	`setOverlay(boolean overlay)` Set the value of the OVERLAY attribute which means that the frame can overlay other frames on the display.
`void`	`setOverlay(logical overlay)` Set the value of the CENTERED attribute which means that the frame can overlay other frames on the display.
`void`	`setSideLabels(boolean sideLabels)` Sets the SIDE-LABELS attribute.
`void`	`setSideLabels(logical sideLabels)` Sets the SIDE-LABELS attribute.

Methods inherited from interface com.goldencode.p2j.util.IterableResource
currentIteration, getIteration, getIteration, setCurrentIteration

- Method Detail
  - isCentered
```
logical isCentered()
```
    Get the value of the CENTERED attribute which defines if the frame is to be centered in the width of the parent window.
    
    Returns:
    
    true if the frame is centered.
  - setCentered
```
void setCentered(boolean center)
```
    Set the value of the CENTERED attribute which defines if the frame is to be centered in the width of the parent window.
    
    Parameters:
    
    center - true if the frame is to be centered.
  - setCentered
```
void setCentered(logical center)
```
    Set the value of the CENTERED attribute which defines if the frame is to be centered in the width of the parent window.
    
    Parameters:
    
    center - true if the frame is to be centered.
  - getDefaultButton
```
handle getDefaultButton()
```
    Get the default button of this frame.
    
    Returns:
    
    handle to current default button.
  - setDefaultButton
```
void setDefaultButton(handle defButton)
```
    Set the default button of this frame.
    
    Parameters:
    
    defButton - handle to current default button.
  - getCancelButton
```
handle getCancelButton()
```
    Gets the cancel button for this frame.
    
    Returns:
    
    button widget that receives the CHOOSE event when a user cancels the current frame or dialog box by pressing the ESC key.
  - setCancelButton
```
void setCancelButton(handle cancelButton)
```
    Sets the cancel button for this frame.
    
    Parameters:
    
    cancelButton - button widget that receives the CHOOSE event when a user cancels the current frame or dialog box by pressing the ESC key.
  - setOverlay
```
void setOverlay(boolean overlay)
```
    Set the value of the OVERLAY attribute which means that the frame can overlay other frames on the display.
    
    Parameters:
    
    overlay - true if the frame can overlay other frames.
  - setOverlay
```
void setOverlay(logical overlay)
```
    Set the value of the CENTERED attribute which means that the frame can overlay other frames on the display.
    
    Parameters:
    
    overlay - true if the frame can overlay other frames.
  - isOverlay
```
logical isOverlay()
```
    Get the value of the OVERLAY attribute which means that the frame can overlay other frames on the display.
    
    Returns:
    
    true if the frame can overlay other frames.
  - borderTopChars
```
decimal borderTopChars()
```
    Get the thickness (in character units) of the border at the top of the frame or dialog box. If the BOX attribute for the widget is yes, this attribute returns 0.
    
    Returns:
    
    the thickness of the border at the top of the frame.
  - borderLeftChars
```
decimal borderLeftChars()
```
    Get the thickness (in character units) of the border at the left of the frame or dialog box. If the BOX attribute for the widget is yes, this attribute returns 0.
    
    Returns:
    
    the thickness of the border at the top of the frame.
  - borderRightChars
```
decimal borderRightChars()
```
    Get the thickness (in character units) of the border at the right of the frame or dialog box. If the BOX attribute for the widget is yes, this attribute returns 0.
    
    Returns:
    
    the thickness of the border at the top of the frame.
  - borderBottomChars
```
decimal borderBottomChars()
```
    Get the thickness (in character units) of the border at the bottom of the frame or dialog box. If the BOX attribute for the widget is yes, this attribute returns 0.
    
    Returns:
    
    the thickness of the border at the top of the frame.
  - borderTopPixels
```
integer borderTopPixels()
```
    Get the thickness (in pixels) of the border at the top of the frame or dialog box. If the BOX attribute for the widget is yes, this attribute returns 0.
    
    Returns:
    
    the thickness of the border at the top of the frame.
  - borderLeftPixels
```
integer borderLeftPixels()
```
    Get the thickness (in pixels) of the border at the left of the frame or dialog box. If the BOX attribute for the widget is yes, this attribute returns 0.
    
    Returns:
    
    the thickness of the border at the top of the frame.
  - borderRightPixels
```
integer borderRightPixels()
```
    Get the thickness (in pixels) of the border at the right of the frame or dialog box. If the BOX attribute for the widget is yes, this attribute returns 0.
    
    Returns:
    
    the thickness of the border at the top of the frame.
  - borderBottomPixels
```
integer borderBottomPixels()
```
    Get the thickness (in pixels) of the border at the bottom of the frame or dialog box. If the BOX attribute for the widget is yes, this attribute returns 0.
    
    Returns:
    
    the thickness of the border at the top of the frame.
  - backgroundIteration
```
handle backgroundIteration()
```
    Get the handle for the background iteration of the frame.
    
    Returns:
    
    the handle for the background iteration of the frame.
  - setSideLabels
```
void setSideLabels(boolean sideLabels)
```
    Sets the SIDE-LABELS attribute.
    
    Parameters:
    
    sideLabels - true if the attribute is set to ON.
  - setSideLabels
```
void setSideLabels(logical sideLabels)
```
    Sets the SIDE-LABELS attribute.
    
    Parameters:
    
    sideLabels - true if the attribute is set to ON.
  - isSideLabels
```
logical isSideLabels()
```
    Get the SIDE-LABELS attribute.
    
    Returns:
    
    true if the attribute is ON.
  - isCarefulPaint
```
logical isCarefulPaint()
```
    Get the CAREFUL-PAINT attribute.
    
    Returns:
    
    true if the attribute is ON.
  - setCarefulPaint
```
void setCarefulPaint(logical careful)
```
    Sets the CAREFUL-PAINTattribute.
    
    Parameters:
    
    careful - true if the attribute is set to ON.
  - setCarefulPaint
```
void setCarefulPaint(boolean careful)
```
    Sets the CAREFUL-PAINTattribute.
    
    Parameters:
    
    careful - true if the attribute is set to ON.
  - line
```
integer line()
```
    Get the current iteration number for down frame.
    
    Returns:
    
    The current iteration number.

Interface FrameInterface

Method Summary

Methods inherited from interface com.goldencode.p2j.util.IterableResource

Method Detail

isCentered

setCentered

setCentered

getDefaultButton

setDefaultButton

getCancelButton

setCancelButton

setOverlay

setOverlay

isOverlay

borderTopChars

borderLeftChars

borderRightChars

borderBottomChars

borderTopPixels

borderLeftPixels

borderRightPixels

borderBottomPixels

backgroundIteration

setSideLabels

setSideLabels

isSideLabels

isCarefulPaint

setCarefulPaint

setCarefulPaint

line