FormElementI (MyTISM API Documentation)

All Known Subinterfaces:

FormElementWithDisplayPropertyI, FTableConfigurationI, FTreeConfigurationI, PopupableFormElementI

All Known Implementing Classes:

FBooleanInputComponent, FBorder, FButton, FCanvas, FChart, FCheckBox, FComboBox, FDateChooser, FDetailView, FEditor, FElement, FEmail, FHideablePanel, FImage, FInputPanel, FJRDesignViewer, FLabel, FLocked, FormAction, FPanel, FPDFViewer, FPopup, FRootPane, FScheduler, FSimpleDurationChooser, FSimpleTimespanChooser, FStyledText, FTab, FTabbedView, FTable, FTableColumn, FText, FTextInputComponent, FTimespanChooser, FToggleButton, FTree, FUri, FView, LiquidSeparatorLabel
```
public interface FormElementI
```
Defines the contract for an element within a form.

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`ALL_ACTIONS`
`static int`	`AVAILABLE_ACTION_KIND`
`static int`	`CONTEXTMENU_ACTION_KIND`
`static int`	`LOCAL_ACTION_KIND`
`static int`	`MENU_ACTION_KIND`
`static int`	`NO_LOCAL_ACTION_KIND`
`static int`	`NO_TOPMDI_ONLY_ACTION_KIND`
`static int`	`NOT_AVAILABLE_ACTION_KIND`
`static int`	`REFRESH_FROM_TRANSACTION`
`static int`	`REFRESH_FROM_USER`
`static int`	`SHORTCUT_ACTION_KIND`
`static int`	`TOOLBAR_ACTION_KIND`
`static int`	`TOPMDI_ONLY_ACTION_KIND`

Method Summary

All Methods Static Methods Instance Methods Abstract Methods Default Methods
Modifier and Type	Method and Description
`void`	`addFormElementListener(FormElementListenerI l)`
`void`	`afterSave()`
`void`	`afterSetValue(java.lang.Object old, java.lang.Object newO)`
`void`	`beforeSave()`
`void`	`beforeSetValue(java.lang.Object old, java.lang.Object newO)`
`void`	`close()`
`java.util.LinkedHashMap`	`getActions()`
`java.util.LinkedHashMap`	`getActionsOfKind(int kind)`
`java.util.HashMap`	`getAttributeMap()`
`electric.xml.Element`	`getConfRoot()`
`ClientContextI`	`getCtx()`
`java.lang.String`	`getDebugName()`
`java.util.HashMap`	`getElementMap()`
`FormContextI`	`getFtx()`
`java.lang.String`	`getName()`
`SchemaI`	`getSchema()`
`void`	`handleAttributes(java.util.HashMap atthash)`
`boolean`	`handleElement(java.util.HashMap elhas, electric.xml.Element el)`
`void`	`handleElements(java.util.HashMap elhash, boolean subsPossible)`
`FormElementI`	`handleNewElement(electric.xml.Element el)`
`boolean`	`isClosed()`
`boolean`	`isDebug()`
`boolean`	`isEditable()`
`boolean`	`isGUIBuilt()`
`boolean`	`isInputPossible()`
`boolean`	`isShown()`
`void`	`mdiActivate(MDIElementI me)` Invoked when this form element is activated within an MDI environment.
`void`	`mdiClose(MDIElementI me)`
`void`	`mdiDeactivate(MDIElementI me)` Invoked when this form element is deactivated within an MDI environment.
`void`	`mdiOpen(MDIElementI me)`
`void`	`postInit()`
`void`	`postRefresh(int from)`
`void`	`refresh()`
`void`	`refresh(int from)`
`void`	`removeFormElementListener(FormElementListenerI l)`
`void`	`requestFocus()`
`boolean`	`setEditable(boolean isEditable)`
`void`	`sync()`
`static java.lang.String`	`toDebugName(java.lang.Object o)` A helper method to create a human-readable string representation of an object, typically a Frame or Component like FPanel.
`boolean`	`willCareForChildActions()`
`boolean`	`willCareForChildRefresh()`

- Field Detail
  - ALL_ACTIONS
```
static final int ALL_ACTIONS
```
    See Also:
    
    Constant Field Values
  - TOOLBAR_ACTION_KIND
```
static final int TOOLBAR_ACTION_KIND
```
    See Also:
    
    Constant Field Values
  - MENU_ACTION_KIND
```
static final int MENU_ACTION_KIND
```
    See Also:
    
    Constant Field Values
  - CONTEXTMENU_ACTION_KIND
```
static final int CONTEXTMENU_ACTION_KIND
```
    See Also:
    
    Constant Field Values
  - SHORTCUT_ACTION_KIND
```
static final int SHORTCUT_ACTION_KIND
```
    See Also:
    
    Constant Field Values
  - LOCAL_ACTION_KIND
```
static final int LOCAL_ACTION_KIND
```
    See Also:
    
    Constant Field Values
  - NO_LOCAL_ACTION_KIND
```
static final int NO_LOCAL_ACTION_KIND
```
    See Also:
    
    Constant Field Values
  - TOPMDI_ONLY_ACTION_KIND
```
static final int TOPMDI_ONLY_ACTION_KIND
```
    See Also:
    
    Constant Field Values
  - NO_TOPMDI_ONLY_ACTION_KIND
```
static final int NO_TOPMDI_ONLY_ACTION_KIND
```
    See Also:
    
    Constant Field Values
  - AVAILABLE_ACTION_KIND
```
static final int AVAILABLE_ACTION_KIND
```
    See Also:
    
    Constant Field Values
  - NOT_AVAILABLE_ACTION_KIND
```
static final int NOT_AVAILABLE_ACTION_KIND
```
    See Also:
    
    Constant Field Values
  - REFRESH_FROM_USER
```
static final int REFRESH_FROM_USER
```
    See Also:
    
    Constant Field Values
  - REFRESH_FROM_TRANSACTION
```
static final int REFRESH_FROM_TRANSACTION
```
    See Also:
    
    Constant Field Values
- Method Detail
  - getConfRoot
```
electric.xml.Element getConfRoot()
```
  - getFtx
```
FormContextI getFtx()
```
  - getCtx
```
ClientContextI getCtx()
```
  - getSchema
```
SchemaI getSchema()
```
  - getName
```
java.lang.String getName()
```
  - getAttributeMap
```
java.util.HashMap getAttributeMap()
```
  - getElementMap
```
java.util.HashMap getElementMap()
```
  - handleAttributes
```
void handleAttributes(java.util.HashMap atthash)
```
  - handleElements
```
void handleElements(java.util.HashMap elhash,
                    boolean subsPossible)
```
  - handleElement
```
boolean handleElement(java.util.HashMap elhas,
                      electric.xml.Element el)
```
  - handleNewElement
```
FormElementI handleNewElement(electric.xml.Element el)
```
  - postInit
```
void postInit()
```
  - mdiOpen
```
void mdiOpen(MDIElementI me)
      throws java.lang.Exception
```
    Throws:
    
    java.lang.Exception
  - mdiClose
```
void mdiClose(MDIElementI me)
       throws java.lang.Exception
```
    Throws:
    
    java.lang.Exception
  - mdiActivate
```
void mdiActivate(MDIElementI me)
          throws java.lang.Exception
```
    Invoked when this form element is activated within an MDI environment.
    This method is called when the form element becomes the active, or currently selected, component in its MDI parent. Implementations should handle any necessary updates, refreshes, or setup that needs to occur when the element is brought into focus.
    
    Parameters:
    
    me - The MDIElementI that is being activated.
    
    Throws:
    
    java.lang.Exception - if an error occurs during activation.
  - mdiDeactivate
```
void mdiDeactivate(MDIElementI me)
            throws java.lang.Exception
```
    Invoked when this form element is deactivated within an MDI environment.
    This method is called when the form element is no longer the active component in its MDI parent. Implementations should handle any necessary cleanup, state saving, or resource release that needs to occur when the element loses focus.
    
    Parameters:
    
    me - The MDIElementI that is being deactivated.
    
    Throws:
    
    java.lang.Exception - if an error occurs during deactivation.
  - addFormElementListener
```
void addFormElementListener(FormElementListenerI l)
```
  - removeFormElementListener
```
void removeFormElementListener(FormElementListenerI l)
```
  - sync
```
void sync()
```
  - beforeSave
```
void beforeSave()
```
  - afterSave
```
void afterSave()
```
  - refresh
```
void refresh(int from)
```
  - refresh
```
void refresh()
```
  - postRefresh
```
void postRefresh(int from)
```
  - willCareForChildRefresh
```
boolean willCareForChildRefresh()
```
  - beforeSetValue
```
void beforeSetValue(java.lang.Object old,
                    java.lang.Object newO)
```
  - afterSetValue
```
void afterSetValue(java.lang.Object old,
                   java.lang.Object newO)
```
  - getActions
```
java.util.LinkedHashMap getActions()
```
  - willCareForChildActions
```
boolean willCareForChildActions()
```
  - getActionsOfKind
```
java.util.LinkedHashMap getActionsOfKind(int kind)
```
  - setEditable
```
boolean setEditable(boolean isEditable)
```
  - isEditable
```
boolean isEditable()
```
  - isShown
```
boolean isShown()
```
  - isInputPossible
```
boolean isInputPossible()
```
  - isGUIBuilt
```
boolean isGUIBuilt()
```
  - requestFocus
```
void requestFocus()
```
  - close
```
void close()
```
  - isClosed
```
boolean isClosed()
```
  - isDebug
```
boolean isDebug()
```
  - getDebugName
```
java.lang.String getDebugName()
```
  - toDebugName
```
static java.lang.String toDebugName(java.lang.Object o)
```
    A helper method to create a human-readable string representation of an object, typically a Frame or Component like FPanel.
    
    Parameters:
    
    o - The Object to format.
    
    Returns:
    
    A formatted String with the object's simple class name and other relevant details.

Interface FormElementI

Field Summary

Method Summary

Field Detail

ALL_ACTIONS

TOOLBAR_ACTION_KIND

MENU_ACTION_KIND

CONTEXTMENU_ACTION_KIND

SHORTCUT_ACTION_KIND

LOCAL_ACTION_KIND

NO_LOCAL_ACTION_KIND

TOPMDI_ONLY_ACTION_KIND

NO_TOPMDI_ONLY_ACTION_KIND

AVAILABLE_ACTION_KIND

NOT_AVAILABLE_ACTION_KIND

REFRESH_FROM_USER

REFRESH_FROM_TRANSACTION

Method Detail

getConfRoot

getFtx

getCtx

getSchema

getName

getAttributeMap

getElementMap

handleAttributes

handleElements

handleElement

handleNewElement

postInit

mdiOpen

mdiClose

mdiActivate

mdiDeactivate

addFormElementListener

removeFormElementListener

sync

beforeSave

afterSave

refresh

refresh

postRefresh

willCareForChildRefresh

beforeSetValue

afterSetValue

getActions

willCareForChildActions

getActionsOfKind

setEditable

isEditable

isShown

isInputPossible

isGUIBuilt

requestFocus

close

isClosed

isDebug

getDebugName

toDebugName