Class FormArea

All Implemented Interfaces:
ClipboardTranslator.Provider, RegionTextQueryTranslator.Provider, Area, HotPoint, HotPointControl, Lines
Direct Known Subclasses:
Area, FormPopup, MessageArea, WizardArea

public class FormArea extends NavigationArea
The area with a set of controls. FormArea lets the user to interact with a number of controls of various types in one single area. The controls can be of the following types:
  • Single line edits
  • Checkboxes
  • Lists
  • UniRefs
  • Static items
  • Multiline edit
Multiline edit can be only a single in FormArea and always placed at the bottom below of all other controls. Controls of all other types can be inserted multiple times and in the arbitrary order.

Each control, except of multiline edit, has associated name which helps the developer reference this control. As well, each control can be associated with some object given by an opaque Object reference. The purpose of this object every developer may define completely freely as it could be convenient for a particular purpose.

  • Field Details

  • Constructor Details

  • Method Details

    • clear

      public void clear()
    • hasItemWithName

      public boolean hasItemWithName(String itemName)
    • getItemNewAutoName

      public String getItemNewAutoName()
    • getItemTypeOnLine

      public FormArea.Type getItemTypeOnLine(int index)
    • getItemCount

      public int getItemCount()
    • getItemNameOnLine

      public String getItemNameOnLine(int index)
    • getItemObj

      public Object getItemObj(int index)
    • getItemObjByName

      public Object getItemObjByName(String itemName)
    • addEdit

      public boolean addEdit(String itemName, String caption)
    • addEdit

      public boolean addEdit(String itemName, String caption, String initialText)
    • addEdit

      public boolean addEdit(String itemName, String caption, String initialText, Object obj, boolean enabled)
    • addPasswd

      public boolean addPasswd(String name, String caption, String text, Object obj, boolean enabled)
    • setEnteredText

      public void setEnteredText(String itemName, String newText)
    • getEnteredText

      public String getEnteredText(String itemName)
    • getEnteredText

      public String getEnteredText(int lineIndex)
    • addUniRef

      public boolean addUniRef(String itemName, String caption, String initialUniRef, Object obj, boolean enabled)
    • getUniRefInfo

      public UniRefInfo getUniRefInfo(String itemName)
    • getUniRefInfo

      public UniRefInfo getUniRefInfo(int lineIndex)
    • addList

      public boolean addList(String itemName, String caption, Object initialSelectedItem, FormArea.ListChoosing listChoosing, Object obj, boolean enabled)
    • getSelectedListItem

      public Object getSelectedListItem(String itemName)
    • addCheckbox

      public boolean addCheckbox(String itemName, String caption, boolean initialState, Object obj, boolean enabled)
    • addCheckbox

      public boolean addCheckbox(String itemName, String caption, boolean initialState)
    • getCheckboxState

      public boolean getCheckboxState(String itemName)
    • addStatic

      public boolean addStatic(String itemName, String caption, Object obj)
    • addStatic

      public boolean addStatic(String itemName, String caption)
    • addStatic

      public boolean addStatic(String caption)
    • isMultilineEditActivated

      public boolean isMultilineEditActivated()
    • isMultilineEditEnabled

      public boolean isMultilineEditEnabled()
    • multilineEditHasCaption

      public boolean multilineEditHasCaption()
    • createMultilineEditParams

      public MultilineEdit.Params createMultilineEditParams(ControlContext context, MutableLines lines)
    • activateMultilineEdit

      public boolean activateMultilineEdit(String caption, MutableMarkedLines content, MultilineEdit.Params params, boolean enabled)
    • activateMultilineEdit

      public boolean activateMultilineEdit(String caption, String[] text, boolean enabled)
    • activateMultilineEdit

      public boolean activateMultilineEdit(String caption, String[] text)
    • updateMultilineEdit

      public boolean updateMultilineEdit(FormArea.MultilineEditUpdating updating)
    • getMultilineEditHotPoint

      public HotPoint getMultilineEditHotPoint()
    • isHotPointInMultilineEdit

      public boolean isHotPointInMultilineEdit()
    • isPointInMultilineEdit

      public boolean isPointInMultilineEdit(int x, int y)
    • getMultilineEditText

      public String getMultilineEditText(String lineSeparator)
    • getMultilineEditText

      public String[] getMultilineEditText()
    • getMultilineEditContent

      public MutableMarkedLines getMultilineEditContent()
    • removeItemOnLine

      public boolean removeItemOnLine(int index)
    • removeItemByName

      public boolean removeItemByName(String itemName)
    • getMultilineEditChangeListeners

      public List<FormArea.MultilineEditChangeListener> getMultilineEditChangeListeners()
    • onInputEvent

      public boolean onInputEvent(InputEvent event)
      Specified by:
      onInputEvent in interface Area
      onInputEvent in class NavigationArea
    • onSystemEvent

      public boolean onSystemEvent(SystemEvent event)
      Specified by:
      onSystemEvent in interface Area
      onSystemEvent in class NavigationArea
    • onAreaQuery

      public boolean onAreaQuery(AreaQuery query)
      Specified by:
      onAreaQuery in interface Area
      onAreaQuery in class NavigationArea
    • getLineCount

      public int getLineCount()
    • getLine

      public String getLine(int index)
    • announceLine

      public void announceLine(int index, String line)
      announceLine in class NavigationArea
    • getNewHotPointX

      public int getNewHotPointX(int oldHotPointY, int newHotPointY, int oldHotPointX, String oldLine, String newLine)
      getNewHotPointX in class NavigationArea
    • getAreaName

      public String getAreaName()
    • setAreaName

      public void setAreaName(String name)
    • findItemByIndex

      protected FormArea.Item findItemByIndex(int index)
    • findItemByName

      protected FormArea.Item findItemByName(String itemName)
    • updateItems

      protected void updateItems()
    • notifyChangeListeners

      protected void notifyChangeListeners(Event event)