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

java.lang.Object
- com.goldencode.p2j.util.HandleResource
- - com.goldencode.p2j.util.HandleChain
  - - com.goldencode.p2j.ui.GenericWidget<T>
    - - com.goldencode.p2j.ui.BaseEntity<FieldGroupConfig>
      - com.goldencode.p2j.ui.FieldGroup

All Implemented Interfaces:

Checkable, CommonWidget, ConfigOwner<FieldGroupConfig>, CustomFont, DisableRedraw, FieldGroupInterface, Group, ImageSupport, ImageWidgetSupport, WidgetContainer, WriteProtectable, CommonField, CommonHandle, CommonHandleChain, CommonHandleTree, Coordinates, DatabaseInfo, Deletable, DynamicResource, HasVisible, InstantiatingProcedure, Nameable, Sensitive, Sizeable, WrappedResource, Printable
```
public class FieldGroup
extends BaseEntity<FieldGroupConfig>
implements Group, WidgetContainer, FieldGroupInterface
```
Groups widgets together into a list of siblings that can be accessed via the first or last entry in the list.

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class FieldGroup.UpdatesOp
Defines the tab item list rearrangements.
- Nested classes/interfaces inherited from class com.goldencode.p2j.ui.BaseEntity
  BaseEntity.CharsPixels

Nested Classes
Modifier and Type	Class and Description
`static class`	`FieldGroup.UpdatesOp` Defines the tab item list rearrangements.

Field Summary

Fields
Modifier and Type	Field and Description
`private GenericWidget<?>`	`firstTabItem` The first tab item
`private GenericWidget<?>`	`lastTabItem` The last tab item
`private java.util.List<GenericWidget<?>>`	`tabItems` Tab item list
`private java.util.function.Consumer<GenericWidget<?>>`	`widgetAdder` Function for adding widgets.
`private java.util.List<GenericWidget<?>>`	`widgets` The list of contained widgets.

Fields inherited from class com.goldencode.p2j.ui.BaseEntity
group

Fields inherited from class com.goldencode.p2j.ui.GenericWidget
config, deleted, frame, internalScreenValueUsage, realizeOnAttributeAccess

Fields inherited from class com.goldencode.p2j.util.HandleChain
name, nextSibling, prevSibling, wa

Fields inherited from class com.goldencode.p2j.util.HandleResource
instProc, pm

Constructor Summary

Constructors
Constructor and Description

FieldGroup(boolean dynamic, FieldGroup beforeFg)
Creates an instance to groups related widgets in a frame.

Constructors
Constructor and Description
`FieldGroup(boolean dynamic, FieldGroup beforeFg)` Creates an instance to groups related widgets in a frame.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`_isHidden()` Get the HIDDEN attribute - in this case, is taken from the frame.
`boolean`	`_isVisible()` Get the VISIBLE attribute - in this case, is taken from the frame.
`void`	`addDynamicWidget(GenericWidget<?> dynWidget)` Adding new dynamic widget to the current group.
`void`	`addDynamicWidget(GenericWidget<?> dynWidget, boolean notifyOwnerFrame)` Adding new dynamic widget to this group.
`void`	`addNewTabItem(GenericWidget<?> widget)` Adds a new tab item to the end of the tab item list if the target widget is not in this list and notifies the client about the changes.
`void`	`addWidget(GenericWidget<?> widget)` Add the specified widget to this field-group.
`protected boolean`	`canDelete()` Check if this resource can be deleted (implicitly or not).
`void`	`cleanNonTabItems()` Remove from the list of tab items the items that became non-tab items.
`void`	`delete()` Delete the resource.
`handle`	`firstChild()` Accesses the first widget in the list of contained widgets.
`private GenericWidget<?>`	`getExtremeTabItem(boolean first)` Accesses the the first and the last field-level widget in the given field group.
`handle`	`getFirstTabItem()` Getting the FIRST-TAB-ITEM attribute.
`integer`	`getFont()` Get the FONT attribute of this widget.
`decimal`	`getHeightChars()` Get rectangle FIELD-GROUP:HEIGHT-CHARS value.
`integer`	`getHeightPixels()` Get rectangle FIELD-GROUP:HEIGHT-PIXELS value.
`handle`	`getLastTabItem()` Getting the LAST-TAB-ITEM attribute.
`GenericWidget<?>`	`getNextChild(GenericWidget<?> child)` Accesses the next widget in the list of contained widgets.
`integer`	`getNumTabs()` Get the NUM-TABS attribute, which indicates the number of tab widgets inside this field-group container.
`CommonWidget`	`getParent()` Gets the PARENT writable attribute.
`GenericWidget<?>`	`getPrevChild(GenericWidget<?> child)` Accesses the previous widget in the list of contained widgets.
`handle`	`getTabItem(int tabPosition)` Get the handle of the tab item by the given tab position.
`handle`	`getTabItem(integer tabPosition)` Get the handle of the tab item by the given tab position.
`int[]`	`getTabItemList()` Return the current tab item list.
`integer`	`getTabPosition(GenericWidget<?> widget)` Returns the tab position of the given tab item.
`protected java.lang.String[]`	`getValidParentTypes()` Returns the widget types that can act as parent for this widget.
`java.util.Collection<GenericWidget<?>>`	`getWidgets()` Extracts field-group widgets.
`decimal`	`getWidthChars()` Get rectangle FIELD-GROUP:WIDTH-CHARS value.
`integer`	`getWidthPixels()` Get rectangle FIELD-GROUP:WIDTH-PIXELS value.
`logical`	`isForeground()` Getting the FOREGROUND attribute.
`handle`	`lastChild()` Accesses the last widget in the list of contained widgets.
`private void`	`moveTabItem(GenericWidget<?> widget, java.util.function.Supplier<java.lang.Integer> index)` Moves the specified widget to the specified index position in the tab item list.
`private void`	`moveTabItemAtTop(GenericWidget<?> widget, int pos)` Removes the target widget from the tab item list, add it at the top of the tab item list at the given position and shifts the other tab items below this target widget.
`private void`	`moveTabItemToEnd(GenericWidget<?> widget)` Removes the target widget from the tab item list and add it to the end of the tab item list.
`void`	`moveWidgetAfter(GenericWidget<?> widget, GenericWidget<?> after)` Move the target widget after the provided widget in this field-group.
`void`	`moveWidgetBefore(GenericWidget<?> widget, GenericWidget<?> before)` Move the target widget before the provided widget in this field-group.
`void`	`name(character name)` Sets the name of this handle.This method is outside interfaces and only meant for initializing this within the implementation.
`handle`	`nextTabItem(GenericWidget<?> widget)` Obtains the next tab item in this field group after the provided widget.
`private handle`	`nextTabItem(GenericWidget<?> widget, boolean reverse)` Obtains the next tab item in this field group after the provided widget following the given direction.
`private void`	`placeWidgetInTabList(GenericWidget<?> widget, FieldGroup.UpdatesOp op, int pos)` Places the given widget in the current tab item list.
`handle`	`previousTabItem(GenericWidget<?> widget)` Obtains the previous tab item in this field group after the provided widget.
`void`	`removeWidget(GenericWidget<?> widget)` Remove the specified widget from this field-group.
`protected boolean`	`resourceDelete()` Delete the resource.
`void`	`setFirstTabItem(handle wHandle)` Setting the FIRST-TAB-ITEM attribute.
`void`	`setFont(int64 fontNum)` Set the FONT attribute of this widget.
`void`	`setFont(long fontNum)` Set the FONT attribute of this widget.
`void`	`setFrame(GenericFrame frame)` Sets the containing frame instance.
`void`	`setLastTabItem(handle wHandle)` Setting the LAST-TAB-ITEM attribute.
`private void`	`setTabItemAfter(GenericWidget<?> widget, GenericWidget<?> after)` Set the tab item after the provided widget in this field-group.
`private void`	`setTabItemBefore(GenericWidget<?> widget, GenericWidget<?> before)` Set the tab item before the provided widget in this field-group.
`void`	`setWidgetAdder(java.util.function.Consumer<GenericWidget<?>> widgetAdder)` Set the value of the widgetAdder Consumer.
`void`	`setWidgets(java.util.List<GenericWidget<?>> widgets)` Refresh the widgets so now they are part of this field-group.
`protected void`	`toBottom(GenericWidget<?> widget)` Moves the target widget to the bottom of this list.
`protected void`	`toTop(GenericWidget<?> widget)` Moves the target widget to the top of this list.
`private void`	`updateExtremeTabItems()` Updates the first and last tab items if there are initialized.
`int[]`	`updateTabItemList(int[] widgetIds, FieldGroup.UpdatesOp op)` Update the current tab item list.
`int[]`	`updateTabItemList(java.util.List<GenericWidget<?>> widgets, FieldGroup.UpdatesOp op)` Update the current tab item list.
`void`	`updateTabItemsOnTabStop(GenericWidget<?> widget, boolean addToEnd)` Updates tab items on tab stop.
`protected boolean`	`useHandleChainSiblings()` Indicates, that HandleChain implementation of siblings methods should be used.

Methods inherited from class com.goldencode.p2j.ui.BaseEntity
_getHeightChars, _getHeightPixels, _getWidthChars, _getWidthPixels, canSetPixelPositionInChui, changeFontWorker, emit4084Warning, emitUnableToAssignUnknownAttributeWarning, getBgColor, getBgColorRgb, getColumn, getDColor, getFgColor, getFgColorRgb, getFontInfo, getFontName, getFontSize, getFrameColumn, getFrameRow, getFrameX, getFrameY, getNextSibling, getParent, getPfColor, getPrevSibling, getRow, getSizeAttrs, getTitle, getTooltip, getX, getY, isFontBold, isFontItalic, isFontUnderline, isMovable, isResizable, isSelected, isTabStop, prepareSizeChars, prepareSizePixels, pushLocAttrs, pushSizeAttrs, resetAutoResize, setAlign, setBgColor, setBgColor, setBgColor, setBgColorRgb, setBgColorRgb, setColon, setColon, setColumn, setColumn, setColumnOrRow, setColumnOrRowWorker, setDColor, setDColor, setDColor, setFgColor, setFgColor, setFgColor, setFgColorRgb, setFgColorRgb, setFontBold, setFontItalic, setFontName, setFontSize, setFontUnderline, setGroup, setHeightChars, setHeightChars, setHeightCharsWorker, setHeightImpl, setHeightPixels, setHeightPixels, setHeightPixelsWorker, setMaxHeightCharsWorker, setMaxHeightPixelsWorker, setMaxWidthCharsWorker, setMaxWidthPixelsWorker, setMinHeightCharsWorker, setMinHeightPixelsWorker, setMinWidthCharsWorker, setMinWidthPixelsWorker, setMovable, setMovable, setParent, setPfColor, setPfColor, setPfColor, setResizable, setResizable, setRow, setRow, setSelected, setSelected, setSizeChars, setSizePixels, setSystemParent, setTabStop, setTabStop, setTitle, setTitle, setTooltip, setTooltip, setVirtHeightCharsWorker, setVirtHeightPixelsWorker, setVirtWidthCharsWorker, setVirtWidthPixelsWorker, setWidthChars, setWidthChars, setWidthCharsWorker, setWidthImpl, setWidthPixels, setWidthPixels, setWidthPixelsWorker, setX, setX, setXorY, setXOrYWorker, setY, setY, validateParent, validateSize, validColumnOrRow

Methods inherited from class com.goldencode.p2j.ui.GenericWidget
_dynamic, _getDbName, _getFormat, _getTable, _isEntered, _isNotEntered, _isRealized, _name, _setDynamic, _setVisible, afterConfigUpdate, apply, apply, apply, apply, asWidgetHandle, canAccess, canPushWidgetAttr, cleanup, colorDisplay, colorPrompt, config, deselectRows, detachMenu, disable, dynamic, editUndo, enable, finishConfigProcessing, finishSetup, flushWidgetAttrs, genAssignUnknownWarning, getAttr, getAttr, getAttr, getAttr, getAttr, getAttr, getAttr, getAttr, getAttr, getAttr, getAttr, getAttr, getColumnFont, getColumnLabel, getContextHelpId, getConvert3D, getCursorOffset, getDataType, getDbName, getFormat, getFrame, getFrameHandle, getFrameName, getHeight, getHelp, getHWND, getId, getImage, getLabel, getLabelFont, getLabelStr, getLogicalTerminal, getMaxHeightChars, getMaxWidthChars, getMenuKey, getMenuMouse, getMousePointer, getMousePosition, getNextTabItem, getNumColumns, getNumSelectedRows, getParentHandle, getPopupMenu, getPreviousTabItem, getQuery, getRetainShape, getScreenValue, getScreenValue, getSideLabelHandle, getStretchToFit, getTable, getTabPosition, getTitleFont, getTransparent, getValidationExpression, getValidationMessage, getVirtHeight, getVirtHeightPixels, getVirtWidth, getVirtWidthPixels, getWidgetId, getWidth, getWindow, getZOrderClass, hasFormat, hasNameReadOnly, hasParent, hide, hide, implicitDeletion, inputValue, isAutoCompletion, isAutoResize, isAutoReturn, isChained, isChecked, isDisableRedraw, isEntered, isExpandLabel, isFocusedRowSelected, isHidden, isKeepFrameZOrder, isManualHighlight, isModified, isMultiple, isNotEntered, isReadOnly, isScrollable, isSelectable, isSelected, isSelected, isSensitive, isTabWidget, isTextSelected, isThreeD, isValidatable, isVisible, labelSizeCheck, loadImage, loadImage, loadImage, loadImage, loadImage, loadImage, loadImage, loadImage, loadImage, loadImage, loadMousePointer, loadMousePointer, moveAfterTabItem, moveAfterTabItem, moveBeforeTabItem, moveBeforeTabItem, moveToBottom, moveToTop, moveToWorker, name, notQueryable, notQueryable, notSettable, notSettable, notWorker, openPopup, preRealizeCheck, processSideLabel, pushScreenDefinition, pushWidgetAttr, pushWidgetAttr, readOnlyError, readOnlyError, realize, refresh, restoreSharedState, saveSharedState, selectAll, selectFocusedRow, setAtFormatLength, setAttr, setAttr, setAttr, setAttr, setAttr, setAttr, setAttr, setAttr, setAttr, setAttrs, setAutoCompletion, setAutoCompletion, setAutoResize, setAutoResize, setAutoReturn, setAutoReturn, setBlank, setChecked, setChecked, setColumnFont, setColumnFont, setColumnLabel, setColumnLabel, setContextHelpId, setContextHelpId, setConvert3D, setConvert3D, setCursorOffset, setCursorOffset, setDataType, setDataType, setDbname, setDeblank, setDisableAutoZap, setDisableRedraw, setFormat, setFormat, setFrame, setFrame, setFrameHandle, setFrameHandle, setFrameHandle, setFromOCX, setHeader, setHeight, setHelp, setHelp, setHelpDefault, setHelpStatic, setHidden, setHidden, setId, setKeepFrameZOrder, setKeepFrameZOrder, setLabel, setLabel, setLabel, setLabelFont, setLabelFont, setLabelInt, setManualHighlight, setManualHighlight, setMaxHeightChars, setMaxWidthChars, setMenuKey, setMenuKey, setMenuMouse, setMenuMouse, setModified, setModified, setMultiple, setMultiple, setNextTabItem, setNoAutoValidate, setNumSelectedRows, setParentHandle, setParentHandle, setPopupMenu, setPopupMenu, setQuery, setReadOnly, setRetainShape, setRetainShape, setScreenLock, setScreenValue, setScreenValue, setScreenValue, setScreenValue, setScreenValueInt, setScreenValueNoErrorHandling, setScrollable, setScrollable, setSelectable, setSelectable, setSensitive, setSensitive, setSensitive, setSensitive, setSideLabelHandle, setStretchToFit, setStretchToFit, setTable, setThreeD, setThreeD, setTitleFont, setTitleFont, setTransparent, setTransparent, setValidation, setValidation, setVertical, setVirtHeight, setVirtHeightPixels, setVirtWidth, setVirtWidthPixels, setVisible, setVisible, setWidgetId, setWidgetId, setWidth, truncatePixelSize, type, underline, underline, valid, validate, validateFields, validateFields, validateFields, validateFields, validateLabelAssignment, view, warningAlreadyRealized, widgetName

Methods inherited from class com.goldencode.p2j.util.HandleChain
firstResource, firstResource, getHead, getNextSibling, getPrevSibling, getPrivateData, getTail, hasName, hasNameConstraints, hasNextSibling, hasPrevSibling, hasPrivateData, interlink, lastResource, lastResource, moveInChain, name, resolveChainType, setHead, setNextSibling, setNextSibling, setPrevSibling, setPrevSibling, setPrivateData, setPrivateData, setPrivateData, validateName

Methods inherited from class com.goldencode.p2j.util.HandleResource
_instantiatingProcedure, addToPool, doDelete, equals, hashCode, id, id, incrementTrigger, instantiatingProcedure, invalidAttribute, processResource, registerResource, resourceType, setInstantiatingProcedure, toString, unableToAssignUnknown, unknown

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

Methods inherited from interface com.goldencode.p2j.ui.CommonWidget
apply, apply, apply, apply, asWidgetHandle, colorDisplay, colorPrompt, deselectRows, disable, editUndo, enable, getBgColor, getBgColorRgb, getColumnFont, getContextHelpId, getCursorOffset, getDColor, getFgColor, getFgColorRgb, getFrame, getFrameColumn, getFrameHandle, getFrameName, getFrameRow, getFrameX, getFrameY, getHWND, getId, getIdEx, getImage, getLabelFont, getLabelStr, getListItems, getMaxHeightChars, getMaxWidthChars, getMenuKey, getMenuMouse, getMousePointer, getMousePosition, getNextTabItem, getNumColumns, getNumSelectedRows, getParentHandle, getPfColor, getPopupMenu, getPreviousTabItem, getQuery, getScreenValue, getSideLabelHandle, getTabPosition, getTitle, getTitleFont, getTooltip, getVirtHeight, getVirtHeightPixels, getVirtWidth, getVirtWidthPixels, getWidgetId, getWindow, hide, hide, inputValue, isAutoCompletion, isAutoResize, isEditCanUndo, isEntered, isFocusedRowSelected, isHidden, isKeepFrameZOrder, isManualHighlight, isModified, isMovable, isMultiple, isNotEntered, isResizable, isScrollable, isSelectable, isSelected, isSelected, isSelected, isTabStop, isThreeD, isValidatable, loadMousePointer, loadMousePointer, moveAfterTabItem, moveAfterTabItem, moveBeforeTabItem, moveBeforeTabItem, moveToBottom, moveToTop, openPopup, preRealizeCheck, realize, refresh, selectAll, selectFocusedRow, setAtFormatLength, setAutoCompletion, setAutoCompletion, setAutoResize, setAutoResize, setBgColor, setBgColorRgb, setBlank, setColumnFont, setColumnFont, setContextHelpId, setContextHelpId, setCursorOffset, setCursorOffset, setDColor, setDColor, setDeblank, setDisableAutoZap, setFgColor, setFgColorRgb, setFormat, setFrame, setFrame, setFrameHandle, setFrameHandle, setFrameHandle, setGroup, setHeader, setHidden, setHidden, setId, setKeepFrameZOrder, setKeepFrameZOrder, setLabelFont, setLabelFont, setListItems, setListItems, setManualHighlight, setManualHighlight, setMaxHeightChars, setMaxWidthChars, setMenuKey, setMenuKey, setMenuMouse, setMenuMouse, setModified, setModified, setMovable, setMovable, setMultiple, setMultiple, setNextTabItem, setNumSelectedRows, setParent, setParentHandle, setParentHandle, setPfColor, setPfColor, setPopupMenu, setPopupMenu, setQuery, setResizable, setResizable, setScreenValue, setScreenValue, setScrollable, setScrollable, setSelectable, setSelectable, setSelected, setSelected, setSensitive, setSideLabelHandle, setTabStop, setTabStop, setThreeD, setThreeD, setTitle, setTitle, setTitleFont, setTitleFont, setTooltip, setTooltip, setValidation, setValidation, setVertical, setVirtHeight, setVirtHeightPixels, setVirtWidth, setVirtWidthPixels, setWidgetId, setWidgetId, underline, underline, valid, validateFields, validateFields, validateFields, view

Methods inherited from interface com.goldencode.p2j.util.CommonHandleChain
getNextSibling, getPrevSibling, getPrivateData, setPrivateData, setPrivateData

Methods inherited from interface com.goldencode.p2j.util.CommonHandle
readOnlyError, readOnlyError, resourceType

Methods inherited from interface com.goldencode.p2j.util.WrappedResource
id, id, unknown

Methods inherited from interface com.goldencode.p2j.util.Nameable
name, name

Methods inherited from interface com.goldencode.p2j.util.CommonField
getColumnLabel, getDataType, getFormat, getHelp, getLabel, setColumnLabel, setColumnLabel, setDataType, setDataType, setFormat, setHelp, setHelp, setLabel, setLabel, setLabel

Methods inherited from interface com.goldencode.p2j.util.DatabaseInfo
getDbName, getTable

Methods inherited from interface com.goldencode.p2j.ui.DisableRedraw
isDisableRedraw, setDisableRedraw, setDisableRedraw

Methods inherited from interface com.goldencode.p2j.util.HasVisible
isVisible, setVisible, setVisible

Methods inherited from interface com.goldencode.p2j.util.Sizeable
getHeight, getWidth, setHeight, setHeightChars, setHeightChars, setHeightPixels, setHeightPixels, setWidth, setWidthChars, setWidthChars, setWidthPixels, setWidthPixels

Methods inherited from interface com.goldencode.p2j.util.Coordinates
getColumn, getRow, getX, getY, setColumn, setColumn, setRow, setRow, setX, setX, setY, setY

Methods inherited from interface com.goldencode.p2j.ui.ImageWidgetSupport
getRetainShape, getStretchToFit, getTransparent, setRetainShape, setRetainShape, setStretchToFit, setStretchToFit, setTransparent, setTransparent

Methods inherited from interface com.goldencode.p2j.ui.ImageSupport
getConvert3D, loadImage, loadImage, loadImage, loadImage, loadImage, loadImage, loadImage, loadImage, loadImage, loadImage, setConvert3D, setConvert3D

Methods inherited from interface com.goldencode.p2j.ui.WriteProtectable
isReadOnly, setReadOnly, setReadOnly

Methods inherited from interface com.goldencode.util.Printable
asString, print

Methods inherited from interface com.goldencode.p2j.util.Deletable
allowDelete

- Field Detail
  - widgets
```
private java.util.List<GenericWidget<?>> widgets
```
    The list of contained widgets.
  - widgetAdder
```
private java.util.function.Consumer<GenericWidget<?>> widgetAdder
```
    Function for adding widgets. The FieldGroup is a server-side only object. However at least in the case of the BACKGROUND attribute they can be changed (widgets can be added) To make these changes visible the widgets should be added to the enclosing frame as well. This Consumer is used for this purpose instead of direct reference to a GenericFrame object to make this link less tight.
  - firstTabItem
```
private GenericWidget<?> firstTabItem
```
    The first tab item
  - lastTabItem
```
private GenericWidget<?> lastTabItem
```
    The last tab item
  - tabItems
```
private java.util.List<GenericWidget<?>> tabItems
```
    Tab item list
- Constructor Detail
  - FieldGroup
```
public FieldGroup(boolean dynamic,
                  FieldGroup beforeFg)
```
    Creates an instance to groups related widgets in a frame.
    
    Parameters:
    
    dynamic - Flag indicating if this is a static or dynamic resource.
    
    beforeFg - The right neighbor of the field-group been created or null if new field-group will be the last in the chain. If beforeFg is the first element in the chain the new BaseEntity will become the new first element in the chain.
- Method Detail
  - setWidgets
```
public void setWidgets(java.util.List<GenericWidget<?>> widgets)
```
    Refresh the widgets so now they are part of this field-group.
    
    Parameters:
    
    widgets - The widgets contained in this instance. This is used as a read-only resource.
  - isForeground
```
public logical isForeground()
```
    Getting the FOREGROUND attribute.
    
    Specified by:
    
    isForeground in interface FieldGroupInterface
    
    Returns:
    
    true if this is a foreground field-group.
  - getHeightPixels
```
public integer getHeightPixels()
```
    Get rectangle FIELD-GROUP:HEIGHT-PIXELS value.
    
    Specified by:
    
    getHeightPixels in interface Sizeable
    
    Overrides:
    
    getHeightPixels in class BaseEntity<FieldGroupConfig>
    
    Returns:
    
    The height of the widget in pixels.
  - getHeightChars
```
public decimal getHeightChars()
```
    Get rectangle FIELD-GROUP:HEIGHT-CHARS value.
    
    Specified by:
    
    getHeightChars in interface Sizeable
    
    Overrides:
    
    getHeightChars in class BaseEntity<FieldGroupConfig>
    
    Returns:
    
    The height of the widget in character units.
  - getWidthChars
```
public decimal getWidthChars()
```
    Get rectangle FIELD-GROUP:WIDTH-CHARS value.
    
    Specified by:
    
    getWidthChars in interface Sizeable
    
    Overrides:
    
    getWidthChars in class BaseEntity<FieldGroupConfig>
    
    Returns:
    
    The width of the widget in character units.
  - getWidthPixels
```
public integer getWidthPixels()
```
    Get rectangle FIELD-GROUP:WIDTH-PIXELS value.
    
    Specified by:
    
    getWidthPixels in interface Sizeable
    
    Overrides:
    
    getWidthPixels in class BaseEntity<FieldGroupConfig>
    
    Returns:
    
    The width of the widget in pixels.
  - getFont
```
public integer getFont()
```
    Get the FONT attribute of this widget.
    
    Specified by:
    
    getFont in interface CommonWidget
    
    Overrides:
    
    getFont in class BaseEntity<FieldGroupConfig>
    
    Returns:
    
    A value representing an entry in the user's font-table.
  - setFont
```
public void setFont(long fontNum)
```
    Set the FONT attribute of this widget.
    
    Specified by:
    
    setFont in interface CommonWidget
    
    Overrides:
    
    setFont in class GenericWidget<FieldGroupConfig>
    
    Parameters:
    
    fontNum - An entry in the font-table or unknown to refer the default font.
  - setFont
```
public void setFont(int64 fontNum)
```
    Set the FONT attribute of this widget.
    
    Specified by:
    
    setFont in interface CommonWidget
    
    Overrides:
    
    setFont in class BaseEntity<FieldGroupConfig>
    
    Parameters:
    
    fontNum - An entry in the font-table or unknown to refer the default font.
  - removeWidget
```
public void removeWidget(GenericWidget<?> widget)
```
    Remove the specified widget from this field-group.
    
    Specified by:
    
    removeWidget in interface WidgetContainer
    
    Parameters:
    
    widget - The widget to be removed.
  - addWidget
```
public void addWidget(GenericWidget<?> widget)
```
    Add the specified widget to this field-group.
    
    Specified by:
    
    addWidget in interface WidgetContainer
    
    Parameters:
    
    widget - The widget to be added to this field group.
  - addNewTabItem
```
public void addNewTabItem(GenericWidget<?> widget)
```
    Adds a new tab item to the end of the tab item list if the target widget is not in this list and notifies the client about the changes. The widget can be added during addWidget calls.
    
    Parameters:
    
    widget - The widget to be added to the tab item list.
  - moveTabItemToEnd
```
private void moveTabItemToEnd(GenericWidget<?> widget)
```
    Removes the target widget from the tab item list and add it to the end of the tab item list.
    
    Parameters:
    
    widget - The target widget
  - moveTabItemAtTop
```
private void moveTabItemAtTop(GenericWidget<?> widget,
                              int pos)
```
    Removes the target widget from the tab item list, add it at the top of the tab item list at the given position and shifts the other tab items below this target widget.
    
    Parameters:
    
    widget - The target widget
    
    pos - The position to place new widget.
  - placeWidgetInTabList
```
private void placeWidgetInTabList(GenericWidget<?> widget,
                                  FieldGroup.UpdatesOp op,
                                  int pos)
```
    Places the given widget in the current tab item list.
    
    Parameters:
    
    widget - The widget
    
    op - The current tab item list rearranging operation
    
    pos - The widget position in the corresponding rearranging statement
  - updateTabItemsOnTabStop
```
public void updateTabItemsOnTabStop(GenericWidget<?> widget,
                                    boolean addToEnd)
```
    Updates tab items on tab stop.
    
    Parameters:
    
    widget - The given widget
    
    addToEnd - The true value indicates that the given widget is placed at the end of the tab item list, otherwise its tab position is not changed.
  - moveWidgetAfter
```
public void moveWidgetAfter(GenericWidget<?> widget,
                            GenericWidget<?> after)
```
    Move the target widget after the provided widget in this field-group.
    
    Parameters:
    
    widget - The target widget to be moved.
    
    after - The provided widget.
  - moveWidgetBefore
```
public void moveWidgetBefore(GenericWidget<?> widget,
                             GenericWidget<?> before)
```
    Move the target widget before the provided widget in this field-group.
    
    Parameters:
    
    widget - The target widget to be moved.
    
    before - The provided widget.
  - setFrame
```
public void setFrame(GenericFrame frame)
```
    Sets the containing frame instance.
    This updates the field-group's parentId, too.
    
    Specified by:
    
    setFrame in interface CommonWidget
    
    Overrides:
    
    setFrame in class GenericWidget<FieldGroupConfig>
    
    Parameters:
    
    frame - GenericFrame instance that contains this widget
  - name
```
public void name(character name)
```
    Sets the name of this handle.This method is outside interfaces and only meant for initializing this within the implementation.
    
    Specified by:
    
    name in interface Nameable
    
    Overrides:
    
    name in class HandleChain
    
    Parameters:
    
    name - The handle type to be set.
  - getParent
```
public CommonWidget getParent()
```
    Gets the PARENT writable attribute. This is an override for the BaseEntity's implementation. If this field group is a member of another field group, that field group is returned as parent. Otherwise, the owning frame is returned as the parent.
    
    Specified by:
    
    getParent in interface CommonWidget
    
    Overrides:
    
    getParent in class BaseEntity<FieldGroupConfig>
    
    Returns:
    
    the parent widget for this widget
  - firstChild
```
public handle firstChild()
```
    Accesses the first widget in the list of contained widgets.
    
    Specified by:
    
    firstChild in interface CommonHandleTree
    
    Returns:
    
    The first widget or an unknown handle if no widgets are contained.
  - lastChild
```
public handle lastChild()
```
    Accesses the last widget in the list of contained widgets.
    
    Specified by:
    
    lastChild in interface CommonHandleTree
    
    Returns:
    
    The last widget or an unknown handle if no widgets are contained.
  - getNextChild
```
public GenericWidget<?> getNextChild(GenericWidget<?> child)
```
    Accesses the next widget in the list of contained widgets.
    
    Specified by:
    
    getNextChild in interface Group
    
    Parameters:
    
    child - The widget in the list for which to find the following child.
    
    Returns:
    
    The next widget or a null if there is no subsequent widget.
  - getPrevChild
```
public GenericWidget<?> getPrevChild(GenericWidget<?> child)
```
    Accesses the previous widget in the list of contained widgets.
    
    Specified by:
    
    getPrevChild in interface Group
    
    Parameters:
    
    child - The widget in the list for which to find the preceding child.
    
    Returns:
    
    The previous widget or null if there is no preceding widget.
  - getFirstTabItem
```
public handle getFirstTabItem()
```
    Getting the FIRST-TAB-ITEM attribute.
    
    Specified by:
    
    getFirstTabItem in interface FieldGroupInterface
    
    Returns:
    
    The widget handle that is the first in the frame tab order
  - getLastTabItem
```
public handle getLastTabItem()
```
    Getting the LAST-TAB-ITEM attribute.
    
    Specified by:
    
    getLastTabItem in interface FieldGroupInterface
    
    Returns:
    
    The widget handle that is the last in the frame tab order
  - setFirstTabItem
```
public void setFirstTabItem(handle wHandle)
```
    Setting the FIRST-TAB-ITEM attribute.
    
    Specified by:
    
    setFirstTabItem in interface FieldGroupInterface
    
    Parameters:
    
    wHandle - The handle of widget in this field-group to assign as first in the tab order.
  - setLastTabItem
```
public void setLastTabItem(handle wHandle)
```
    Setting the LAST-TAB-ITEM attribute.
    
    Specified by:
    
    setLastTabItem in interface FieldGroupInterface
    
    Parameters:
    
    wHandle - The handle of widget in this field-group to assign as last in the tab order.
  - getWidgets
```
public java.util.Collection<GenericWidget<?>> getWidgets()
```
    Extracts field-group widgets.
    
    Returns:
    
    widgets collection.
  - addDynamicWidget
```
public void addDynamicWidget(GenericWidget<?> dynWidget)
```
    Adding new dynamic widget to the current group.
    
    Parameters:
    
    dynWidget - The widget to be added to this group.
  - addDynamicWidget
```
public void addDynamicWidget(GenericWidget<?> dynWidget,
                             boolean notifyOwnerFrame)
```
    Adding new dynamic widget to this group.
    
    Parameters:
    
    dynWidget - The widget to be added to this group.
    
    notifyOwnerFrame - The true value indicates that the owner frame must be notified about new widget.
  - setWidgetAdder
```
public void setWidgetAdder(java.util.function.Consumer<GenericWidget<?>> widgetAdder)
```
    Set the value of the widgetAdder Consumer.
    
    Parameters:
    
    widgetAdder - the new value of the widgetAdder.
  - getTabItemList
```
public int[] getTabItemList()
```
    Return the current tab item list.
    
    Returns:
    
    The tab item list
  - updateTabItemList
```
public int[] updateTabItemList(int[] widgetIds,
                               FieldGroup.UpdatesOp op)
```
    Update the current tab item list.
    
    Parameters:
    
    widgetIds - The array of widget ids
    
    op - The current tab item list rearranging operation
    
    Returns:
    
    The tab item list
  - updateTabItemList
```
public int[] updateTabItemList(java.util.List<GenericWidget<?>> widgets,
                               FieldGroup.UpdatesOp op)
```
    Update the current tab item list.
    
    Parameters:
    
    widgets - The array of widgets
    
    op - The current tab item list rearranging operation
    
    Returns:
    
    The tab item list
  - nextTabItem
```
public handle nextTabItem(GenericWidget<?> widget)
```
    Obtains the next tab item in this field group after the provided widget.
    
    Parameters:
    
    widget - The provided widget
    
    Returns:
    
    An instance of GenericWidget or null.
  - previousTabItem
```
public handle previousTabItem(GenericWidget<?> widget)
```
    Obtains the previous tab item in this field group after the provided widget.
    
    Parameters:
    
    widget - The provided widget
    
    Returns:
    
    An instance of GenericWidget or null.
  - delete
```
public void delete()
```
    Delete the resource.
    Field groups need to be manually removed from the registry, when they are deleted.
    
    Specified by:
    
    delete in interface Deletable
    
    Overrides:
    
    delete in class GenericWidget<FieldGroupConfig>
  - toTop
```
protected void toTop(GenericWidget<?> widget)
```
    Moves the target widget to the top of this list.
    
    Parameters:
    
    widget - The target widget
  - toBottom
```
protected void toBottom(GenericWidget<?> widget)
```
    Moves the target widget to the bottom of this list.
    
    Parameters:
    
    widget - The target widget
  - nextTabItem
```
private handle nextTabItem(GenericWidget<?> widget,
                           boolean reverse)
```
    Obtains the next tab item in this field group after the provided widget following the given direction.
    
    Parameters:
    
    widget - The provided widget
    
    reverse - The boolean value that defines the iteration order direction
    
    Returns:
    
    An instance of GenericWidget or null.
  - useHandleChainSiblings
```
protected boolean useHandleChainSiblings()
```
    Indicates, that HandleChain implementation of siblings methods should be used.
    
    Overrides:
    
    useHandleChainSiblings in class BaseEntity<FieldGroupConfig>
    
    Returns:
    
    TRUE - if the logic of parent class HandleChain is used, FALSE - if own siblings implementation logic is used.
  - getValidParentTypes
```
protected java.lang.String[] getValidParentTypes()
```
    Returns the widget types that can act as parent for this widget.
    
    Overrides:
    
    getValidParentTypes in class BaseEntity<FieldGroupConfig>
    
    Returns:
    
    see above.
  - canDelete
```
protected boolean canDelete()
```
    Check if this resource can be deleted (implicitly or not).
    
    Overrides:
    
    canDelete in class GenericWidget<FieldGroupConfig>
    
    Returns:
    
    See above.
  - resourceDelete
```
protected boolean resourceDelete()
```
    Delete the resource.
    
    Overrides:
    
    resourceDelete in class GenericWidget<FieldGroupConfig>
    
    Returns:
    
    true if the resource was deleted.
  - getExtremeTabItem
```
private GenericWidget<?> getExtremeTabItem(boolean first)
```
    Accesses the the first and the last field-level widget in the given field group.
    
    Parameters:
    
    first - The true value indicates that the first will be accessed, otherwise the last widget.
    
    Returns:
    
    The extreme possible field-level widget in this group or null if there are no field level widgets.
  - setTabItemAfter
```
private void setTabItemAfter(GenericWidget<?> widget,
                             GenericWidget<?> after)
```
    Set the tab item after the provided widget in this field-group.
    
    Parameters:
    
    widget - The tab item.
    
    after - The provided widget.
  - setTabItemBefore
```
private void setTabItemBefore(GenericWidget<?> widget,
                              GenericWidget<?> before)
```
    Set the tab item before the provided widget in this field-group.
    
    Parameters:
    
    widget - The tab item.
    
    before - The provided widget.
  - updateExtremeTabItems
```
private void updateExtremeTabItems()
```
    Updates the first and last tab items if there are initialized.
  - getNumTabs
```
public integer getNumTabs()
```
    Get the NUM-TABS attribute, which indicates the number of tab widgets inside this field-group container.
    
    Specified by:
    
    getNumTabs in interface FieldGroupInterface
    
    Returns:
    
    The current value of the NUM-TABS attribute.
  - getTabItem
```
public handle getTabItem(integer tabPosition)
```
    Get the handle of the tab item by the given tab position.
    
    Specified by:
    
    getTabItem in interface FieldGroupInterface
    
    Parameters:
    
    tabPosition - The tab position
    
    Returns:
    
    The handle of the tab item by the given tab position.
  - getTabItem
```
public handle getTabItem(int tabPosition)
```
    Get the handle of the tab item by the given tab position.
    
    Specified by:
    
    getTabItem in interface FieldGroupInterface
    
    Parameters:
    
    tabPosition - The tab position
    
    Returns:
    
    The handle of the tab item by the given tab position.
  - getTabPosition
```
public integer getTabPosition(GenericWidget<?> widget)
```
    Returns the tab position of the given tab item. If the given widget doesn't belong to this field-group, then it returns unknown value.
    
    Parameters:
    
    widget - The tab item.
    
    Returns:
    
    The tab order of a widget within its field group.
  - cleanNonTabItems
```
public void cleanNonTabItems()
```
    Remove from the list of tab items the items that became non-tab items.
  - _isVisible
```
public boolean _isVisible()
```
    Get the VISIBLE attribute - in this case, is taken from the frame.
    
    Overrides:
    
    _isVisible in class GenericWidget<FieldGroupConfig>
    
    Returns:
    
    The current value of VISIBLE attribute.
  - _isHidden
```
public boolean _isHidden()
```
    Get the HIDDEN attribute - in this case, is taken from the frame.
    
    Overrides:
    
    _isHidden in class GenericWidget<FieldGroupConfig>
    
    Returns:
    
    The current value of VISIBLE attribute.
  - moveTabItem
```
private void moveTabItem(GenericWidget<?> widget,
                         java.util.function.Supplier<java.lang.Integer> index)
```
    Moves the specified widget to the specified index position in the tab item list.
    
    Parameters:
    
    widget - The widget to move. The method doesn't fail if the widget doesn't exist in the list, instead it will call LogicalTerminal.updateTabItemList(FieldGroup) to reflect the addition.
    
    index - The index supplier of the new widget position in the tab item list. Provide -1 to move the widget at the end of the list. The index is fetched after the widget is removed from the list.

Class FieldGroup

Nested Class Summary

Nested classes/interfaces inherited from class com.goldencode.p2j.ui.BaseEntity

Field Summary

Fields inherited from class com.goldencode.p2j.ui.BaseEntity

Fields inherited from class com.goldencode.p2j.ui.GenericWidget

Fields inherited from class com.goldencode.p2j.util.HandleChain

Fields inherited from class com.goldencode.p2j.util.HandleResource

Constructor Summary

Method Summary

Methods inherited from class com.goldencode.p2j.ui.BaseEntity

Methods inherited from class com.goldencode.p2j.ui.GenericWidget

Methods inherited from class com.goldencode.p2j.util.HandleChain

Methods inherited from class com.goldencode.p2j.util.HandleResource

Methods inherited from class java.lang.Object

Methods inherited from interface com.goldencode.p2j.ui.CommonWidget

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

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

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

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

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

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

Methods inherited from interface com.goldencode.p2j.ui.DisableRedraw

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

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

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

Methods inherited from interface com.goldencode.p2j.ui.ImageWidgetSupport

Methods inherited from interface com.goldencode.p2j.ui.ImageSupport

Methods inherited from interface com.goldencode.p2j.ui.WriteProtectable

Methods inherited from interface com.goldencode.util.Printable

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

Field Detail

widgets

widgetAdder

firstTabItem

lastTabItem

tabItems

Constructor Detail

FieldGroup

Method Detail

setWidgets

isForeground

getHeightPixels

getHeightChars

getWidthChars

getWidthPixels

getFont

setFont

setFont

removeWidget

addWidget

addNewTabItem

moveTabItemToEnd

moveTabItemAtTop

placeWidgetInTabList

updateTabItemsOnTabStop

moveWidgetAfter

moveWidgetBefore

setFrame

name

getParent

firstChild

lastChild

getNextChild

getPrevChild

getFirstTabItem

getLastTabItem

setFirstTabItem

setLastTabItem

getWidgets

addDynamicWidget

addDynamicWidget

setWidgetAdder

getTabItemList

updateTabItemList

updateTabItemList

nextTabItem

previousTabItem

delete

toTop