Package com.ebasetech.xi.api

Interface BaseWebForm

All Superinterfaces:
BaseForm, Element, EventOwner, MessageContainer, java.io.Serializable, WebFormEventOwner
All Known Subinterfaces:
ApplicationLayout, WebForm
public interface BaseWebForm
extends BaseForm, WebFormEventOwner
BaseWebForm is an interface that represents any Ebase runnable entity that can have controls via a Business View. This interface is extended by WebForm (an interactive form), ApplicationLayout (an Application Layout).
Since:
V5.14

  • Method Details

    • getControls

      Controls getControls()
      Returns the Controls object that gives access to all controls available to the form. An individual control can then be accessed using its control name as shown in the examples below.

      Javascript example: 

       controls.TEXTCONTROL1.hide();
 form.getControls().BUTTONCONTROL2.backgroundColor = "Red";
      Returns:
      Controls
      Since:
      V4.4

    • getControlsByModifier

      Control[] getControlsByModifier​(java.lang.String modifier)
      Returns an array of controls in the form that have the named modifier.

      Modifiers provide a way of flagging one or more controls so they can be found programmatically, e.g. a group of Field Controls might be changed from enterable to display only. Modifiers are assigned to controls at design time using the Modifiers property. Any number of modifiers can be assigned - modifiers are entered as a comma delimited list.

      Javascript example: 

       for each (var ctrl in form.getControlsByModifier("FINANCE"))
 {
   if (!system.securityManager.hasRole("FINANCE_CONTROLLER"))
   {
      ctrl.hide();
   }
 }
      Parameters:
      modifier -
      Returns:
      an array of controls that have the named modifier
      Since:
      V5.9
      See Also:
      Control.hasModifier(String)

    • getThemePath

      java.lang.String getThemePath()
      Returns the path of the theme currently used or null if no theme is configured.
      Returns:
      the theme path
      Since:
      V5.14

    • setThemePath

      void setThemePath​(java.lang.String themePath)
      Changes the Theme used by the current form to the one at the specified path.

      The path should be relative to the root of the Form's project or one of its dependent projects. It must start with a forward slash as a path separator.

      The new Theme must have the same Framework and collection of Property Sets as the current Theme otherwise the Form may not look as expected.

      For further information see:

      JavaScript example: 

       form.setThemePath("/themes/myTheme");
      Parameters:
      themePath - the path of the new theme to be applied
      Since:
      V5.14

    • useProjectTheme

      void useProjectTheme()
      Change the current Form so it uses its Project's configured Theme.

      The Theme must have the same Framework and collection of Property Sets as the current Theme otherwise the Form may not look as expected.

      For further information see:

      JavaScript example: 

       form.useProjectTheme();
      Since:
      V5.13

    • isUseProjectTheme

      boolean isUseProjectTheme()
      Returns true if the form uses the project's theme.
      Returns:
      whether the form should use the project theme
      Since:
      V5.13
      See Also:
      useProjectTheme()

    • getProject

      Project getProject()
      Returns the current project for the running form
      Returns:
      current project
      Since:
      V5.13