public class FieldGroup extends BaseEntity<FieldGroupConfig> implements Group, WidgetContainer
BaseEntity.CharsPixels
Modifier and Type | Field and Description |
---|---|
private java.util.function.Consumer<GenericWidget<?>> |
widgetAdder
Function for adding widgets.
|
private java.util.List<GenericWidget<?>> |
widgets
The list of contained widgets.
|
group
config, deleted, frame
name, nextSibling, prevSibling
instProc
Constructor and Description |
---|
FieldGroup(java.util.List<GenericWidget<?>> widgets,
FieldGroup beforeFg)
Creates an instance to groups related widgets in a frame.
|
Modifier and Type | Method and Description |
---|---|
void |
addDynamicWidget(GenericWidget<?> dynWidget)
Adding new dynamic widget to the current group.
|
void |
addWidget(GenericWidget<?> widget)
Add the specified widget to this field-group.
|
handle |
firstChild()
Accesses the first widget in the list of contained widgets.
|
private GenericWidget<?> |
getFirstFieldLevelItem()
Accesses the first field-level widget in the given field group.
|
handle |
getFirstTabItem()
Getting the FIRST-TAB-ITEM attribute.
|
GenericWidget<?> |
getNextChild(GenericWidget<?> child)
Accesses the next widget in the list of contained widgets.
|
CommonWidget |
getParent()
Gets the PARENT writable attribute.
|
GenericWidget<?> |
getPrevChild(GenericWidget<?> child)
Accesses the previous widget in the list of contained widgets.
|
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.
|
handle |
lastChild()
Accesses the last widget in the list of contained widgets.
|
void |
name(character name)
Sets the name of this handle.This method is outside interfaces and only
meant for initializing this within the implementation.
|
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 |
setFrame(GenericFrame frame)
Sets the containing frame instance.
|
void |
setWidgetAdder(java.util.function.Consumer<GenericWidget<?>> widgetAdder)
Set the value of the widgetAdder Consumer.
|
protected boolean |
useHandleChainSiblings()
Indicates, that HandleChain implementation of siblings methods should be used.
|
canSetPixelPositionInChui, changeFontWorker, getBgColor, getColumn, getDColor, getFgColor, getFont, getFrameColumn, getFrameRow, getFrameX, getFrameY, getHeightChars, getHeightPixels, getNextSibling, getParent, getPfColor, getPrevSibling, getRow, getTitle, getTooltip, getWidthChars, getWidthPixels, getX, getY, isMovable, isResizable, isSelected, isTabStop, prepareSizeChars, prepareSizePixels, resetAutoResize, setAlign, setBgColor, setBgColor, setBgColor, setColon, setColon, setColumn, setColumn, setColumnOrRow, setColumnOrRowWorker, setDColor, setDColor, setDColor, setFgColor, setFgColor, setFgColor, setFont, setGroup, setHeightChars, setHeightChars, setHeightCharsWorker, 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, setTabStop, setTabStop, setTitle, setTitle, setTooltip, setTooltip, setVirtHeightCharsWorker, setVirtHeightPixelsWorker, setVirtWidthCharsWorker, setVirtWidthPixelsWorker, setWidthChars, setWidthChars, setWidthCharsWorker, setWidthPixels, setWidthPixels, setWidthPixelsWorker, setX, setX, setXOrYWorker, setY, setY, validateParent, validateSize, validColumnOrRow
_dynamic, _getDbName, _getFormat, _getTable, _isEntered, _isHidden, _isNotEntered, _isRealized, _isVisible, _setDynamic, _setVisible, afterConfigUpdate, apply, apply, apply, apply, asWidgetHandle, canAccess, canDelete, cleanup, colorDisplay, colorPrompt, config, deselectRows, disable, dynamic, enable, finishConfigProcessing, finishSetup, getColumnFont, getColumnLabel, getContextHelpId, getConvert3D, getCursorOffset, getDataType, getDbName, getFormat, getFrame, getFrameHandle, getHelp, getHWND, getId, getLabel, getLabelFont, getLabelStr, getMaxHeightChars, getMaxWidthChars, getMenuKey, getMenuMouse, getMousePointer, getMousePosition, getNextTabItem, getNumColumns, getNumSelectedRows, getParentHandle, getPopupMenu, getPreviousTabItem, getQuery, getRetainShape, getScreenValue, getScreenValue, getSideLabelHandle, getStretchToFit, getTable, getTitleFont, getTransparent, getVirtHeight, getVirtHeightPixels, getVirtWidth, getVirtWidthPixels, getWidgetId, getWindow, hasNameReadOnly, hasParent, hide, hide, implicitDeletion, inputValue, isAutoResize, isChained, isChecked, isEntered, isFocusedRowSelected, isHidden, isKeepFrameZOrder, isManualHighlight, isModified, isMultiple, isNotEntered, isReadOnly, isScrollable, isSelectable, isSelected, isSelected, isSensitive, isTextSelected, isThreeD, isValidatable, isVisible, labelSizeCheck, loadImage, loadImage, loadImage, loadImage, loadImage, loadImage, loadImage, loadImage, loadImage, loadImage, loadMousePointer, loadMousePointer, moveAfterTab, moveAfterTab, moveBeforeTabItem, moveBeforeTabItem, moveToBottom, moveToTop, moveToWorker, name, notQueryable, notSettable, notWorker, preRealizeCheck, processSideLabel, pushScreenDefinition, readOnlyError, realize, refresh, selectAll, selectFocusedRow, setAtFormatLength, setAutoResize, setAutoResize, setAutoReturn, setBlank, setChecked, setChecked, setColumnFont, setColumnFont, setColumnLabel, setColumnLabel, setContextHelpId, setContextHelpId, setConvert3D, setConvert3D, setCursorOffset, setCursorOffset, setDataType, setDataType, setDbname, setDeblank, setDisableAutoZap, setFont, setFormat, setFormat, setFrame, setFrame, setFrameHandle, setFrameHandle, setFrameHandle, setHeader, setHelp, setHelp, setHelpDefault, setHelpStatic, setHidden, setHidden, setId, setKeepFrameZOrder, setKeepFrameZOrder, 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, 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, truncatePixelSize, underline, underline, valid, validate, validateFields, validateFields, validateFields, validateFields, validateLayout, view, widgetName
delete, firstResource, firstResource, getHead, getNextSibling, getPrevSibling, getPrivateData, getTail, hasName, hasNextSibling, hasPrevSibling, hasPrivateData, interlink, lastResource, lastResource, name, setHead, setNextSibling, setNextSibling, setPrevSibling, setPrevSibling, setPrivateData, setPrivateData, setPrivateData
getResourceType, id, id, instantiatingProcedure, invalidAttribute, setInstantiatingProcedure, type, unknown
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
apply, apply, apply, apply, asWidgetHandle, colorDisplay, colorPrompt, deselectRows, disable, enable, getBgColor, getColumn, getColumnFont, getContextHelpId, getCursorOffset, getDColor, getFgColor, getFont, getFrame, getFrameColumn, getFrameHandle, getFrameRow, getFrameX, getFrameY, getHelp, getHWND, getId, getLabelFont, getLabelStr, getMaxHeightChars, getMaxWidthChars, getMenuKey, getMenuMouse, getMousePointer, getMousePosition, getNextTabItem, getNumColumns, getNumSelectedRows, getParentHandle, getPfColor, getPopupMenu, getPreviousTabItem, getQuery, getRow, getScreenValue, getSideLabelHandle, getTitle, getTitleFont, getTooltip, getVirtHeight, getVirtHeightPixels, getVirtWidth, getVirtWidthPixels, getWidgetId, getWindow, hide, hide, inputValue, isAutoResize, isChecked, isEntered, isFocusedRowSelected, isHidden, isKeepFrameZOrder, isManualHighlight, isModified, isMovable, isMultiple, isNotEntered, isReadOnly, isResizable, isScrollable, isSelectable, isSelected, isSelected, isSelected, isTabStop, isThreeD, isValidatable, isVisible, loadMousePointer, loadMousePointer, moveAfterTab, moveAfterTab, moveBeforeTabItem, moveBeforeTabItem, moveToBottom, moveToTop, preRealizeCheck, realize, refresh, selectAll, selectFocusedRow, setAtFormatLength, setAutoResize, setAutoResize, setAutoReturn, setBgColor, setBlank, setChecked, setChecked, setColumn, setColumn, setColumnFont, setColumnFont, setContextHelpId, setContextHelpId, setCursorOffset, setCursorOffset, setDColor, setDColor, setDeblank, setDisableAutoZap, setFgColor, setFont, setFont, setFormat, setFrame, setFrame, setFrameHandle, setFrameHandle, setFrameHandle, setGroup, setHeader, setHelp, setHelp, setHidden, setHidden, setId, setKeepFrameZOrder, setKeepFrameZOrder, setLabelFont, setLabelFont, setManualHighlight, setManualHighlight, setMaxHeightChars, setMaxWidthChars, setMenuKey, setMenuKey, setMenuMouse, setMenuMouse, setModified, setModified, setMovable, setMovable, setMultiple, setMultiple, setNextTabItem, setNumSelectedRows, setParent, setParentHandle, setParentHandle, setPfColor, setPfColor, setPopupMenu, setPopupMenu, setQuery, setReadOnly, setResizable, setResizable, setRow, setRow, 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, setVisible, setVisible, setWidgetId, setWidgetId, underline, underline, valid, validateFields, validateFields, validateFields, view
getNextSibling, getPrevSibling, getPrivateData, setPrivateData, setPrivateData
getResourceType, readOnlyError
id, id, unknown
getColumnLabel, getDataType, getFormat, getLabel, setColumnLabel, setColumnLabel, setDataType, setDataType, setFormat, setLabel, setLabel
getDbName, getTable
getHeightChars, getHeightPixels, getWidthChars, getWidthPixels, setHeightChars, setHeightChars, setHeightPixels, setHeightPixels, setWidthChars, setWidthChars, setWidthPixels, setWidthPixels
getX, getY, setX, setY
getRetainShape, getStretchToFit, getTransparent, setRetainShape, setRetainShape, setStretchToFit, setStretchToFit, setTransparent, setTransparent
getConvert3D, loadImage, loadImage, loadImage, loadImage, loadImage, loadImage, loadImage, loadImage, loadImage, loadImage, setConvert3D, setConvert3D
private java.util.List<GenericWidget<?>> widgets
private java.util.function.Consumer<GenericWidget<?>> widgetAdder
public FieldGroup(java.util.List<GenericWidget<?>> widgets, FieldGroup beforeFg)
widgets
- The widgets contained in this instance. This is used as a
read-only 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.public void removeWidget(GenericWidget<?> widget)
removeWidget
in interface WidgetContainer
widget
- The widget to be removed.public void addWidget(GenericWidget<?> widget)
addWidget
in interface WidgetContainer
widget
- The widget to be added.public void setFrame(GenericFrame frame)
This updates the field-group's parentId, too.
setFrame
in interface CommonWidget
setFrame
in class GenericWidget<FieldGroupConfig>
frame
- GenericFrame
instance that contains this widgetpublic void name(character name)
name
in interface Nameable
name
in class HandleChain
name
- The handle type to be set.public CommonWidget getParent()
getParent
in interface CommonWidget
getParent
in class BaseEntity<FieldGroupConfig>
public handle firstChild()
firstChild
in interface CommonHandleTree
public handle lastChild()
lastChild
in interface CommonHandleTree
public GenericWidget<?> getNextChild(GenericWidget<?> child)
getNextChild
in interface Group
child
- The widget in the list for which to find the following child.null
if there is no subsequent widget.public GenericWidget<?> getPrevChild(GenericWidget<?> child)
getPrevChild
in interface Group
child
- The widget in the list for which to find the preceding child.null
if there is no preceding widget.public handle getFirstTabItem()
getFirstTabItem
in interface CommonWidget
getFirstTabItem
in class GenericWidget<FieldGroupConfig>
public void setFirstTabItem(handle wHandle)
setFirstTabItem
in interface CommonWidget
setFirstTabItem
in class GenericWidget<FieldGroupConfig>
wHandle
- The handle of widget in this field-group to assign as first in the tab order.public java.util.Collection<GenericWidget<?>> getWidgets()
public void addDynamicWidget(GenericWidget<?> dynWidget)
dynWidget
- The widget to be added to current group.public void setWidgetAdder(java.util.function.Consumer<GenericWidget<?>> widgetAdder)
widgetAdder
- the new value of the widgetAdder.protected boolean useHandleChainSiblings()
useHandleChainSiblings
in class BaseEntity<FieldGroupConfig>
HandleChain
is used,
FALSE - if own siblings implementation logic is used.protected java.lang.String[] getValidParentTypes()
getValidParentTypes
in class BaseEntity<FieldGroupConfig>
protected boolean resourceDelete()
Field groups need to be manually removed from the registry, when they are deleted.
resourceDelete
in class GenericWidget<FieldGroupConfig>
true
if the resource was deleted.private GenericWidget<?> getFirstFieldLevelItem()
null
if there are no field level widgets.