Package de.espirit.firstspirit.access

Interface GuiScriptContext

All Superinterfaces:
BaseContext, ClientScriptContext, ProjectScriptContext, ScriptContext, SpecialistsBroker
All Known Subinterfaces:
Content2ScriptContext, WorkflowScriptContext
public interface GuiScriptContext extends ClientScriptContext, BaseContext
Common properties: ------------------ sessionId (java.lang.Long)
Since:
3.1.170

  • Method Details

    • getGuiHost

      Host getGuiHost()
      Returns the currently active gui host.
      Since:
      4.0.3

    • showForm

      FormData showForm()
      Opens a dialog showing the whole form of the underlying getScript() without language tabs and returns the FormData resulting on user input.
      Returns:
      the FormData resulting on user input or null if user cancels the dialog.
      Since:
      4.2.472

    • showForm

      FormData showForm(boolean showLanguages)
      Opens a dialog showing the whole form of the underlying getScript() and returns the FormData resulting on user input.
      Parameters:
      showLanguages - indicates whether the language tabs should be shown in the opened dialog or not
      Returns:
      the FormData resulting on user input or null if user cancels the dialog.
      Since:
      4.2.472

    • showForm

      FormData showForm(boolean showLanguages, String name)
      Opens a dialog showing a sub part (specified by given name) of the form of the underlying getScript() and returns the FormData resulting on user input.
      Parameters:
      showLanguages - indicates whether the language tabs should be shown in the opened dialog or not
      name - the name of sub part of the form to show
      Returns:
      the FormData resulting on user input or null if user cancels the dialog.
      Since:
      4.2.472

    • getScript

      Script getScript()
      Returns the actual executed script to which this GuiScriptContext belongs
      Returns:
      the actual executed script to which this GuiScriptContext belongs
      Since:
      4.0.17

    • isOnHomePage

      boolean isOnHomePage()
      Indicates whether the underlying script will be executed on the homepage or not.
      Returns:
      true if the underlying script will be executed on the homepage, false otherwise
      Since:
      4.1.12