Package de.espirit.firstspirit.access
Interface GuiScriptContext
- All Superinterfaces:
BaseContext
,ClientScriptContext
,ProjectScriptContext
,ScriptContext
,SpecialistsBroker
- All Known Subinterfaces:
Content2ScriptContext
,WorkflowScriptContext
Common properties:
------------------
sessionId (java.lang.Long)
- Since:
- 3.1.170
-
Nested Class Summary
Nested classes/interfaces inherited from interface de.espirit.firstspirit.access.BaseContext
BaseContext.Env
-
Method Summary
Modifier and TypeMethodDescriptionReturns the currently active gui host.Returns the actual executedscript
to which this GuiScriptContext belongsboolean
Indicates whether the underlyingscript
will be executed on the homepage or not.showForm()
Opens a dialog showing the whole form of the underlyinggetScript()
without language tabs and returns theFormData
resulting on user input.showForm
(boolean showLanguages) Opens a dialog showing the whole form of the underlyinggetScript()
and returns theFormData
resulting on user input.Opens a dialog showing a sub part (specified by given name) of the form of the underlyinggetScript()
and returns theFormData
resulting on user input.Methods inherited from interface de.espirit.firstspirit.access.BaseContext
is
Methods inherited from interface de.espirit.firstspirit.access.ClientScriptContext
getElement, getStoreElement, getUser, getUserGroups
Methods inherited from interface de.espirit.firstspirit.access.project.ProjectScriptContext
getProject, getUserService
Methods inherited from interface de.espirit.firstspirit.access.ScriptContext
getConnection, getProperties, getProperty, logDebug, logError, logError, logInfo, logWarning, removeProperty, setProperty
Methods inherited from interface de.espirit.firstspirit.agency.SpecialistsBroker
requestSpecialist, requireSpecialist
-
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 underlyinggetScript()
without language tabs and returns theFormData
resulting on user input.- Returns:
- the
FormData
resulting on user input ornull
if user cancels the dialog. - Since:
- 4.2.472
-
showForm
Opens a dialog showing the whole form of the underlyinggetScript()
and returns theFormData
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 ornull
if user cancels the dialog. - Since:
- 4.2.472
-
showForm
Opens a dialog showing a sub part (specified by given name) of the form of the underlyinggetScript()
and returns theFormData
resulting on user input.- Parameters:
showLanguages
- indicates whether the language tabs should be shown in the opened dialog or notname
- the name of sub part of the form to show- Returns:
- the
FormData
resulting on user input ornull
if user cancels the dialog. - Since:
- 4.2.472
-
getScript
Script getScript()Returns the actual executedscript
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 underlyingscript
will be executed on the homepage or not.- Returns:
true
if the underlyingscript
will be executed on the homepage,false
otherwise- Since:
- 4.1.12
-