ScreenDefinition (Moqui Framework 3.0.0)

org.moqui.impl.screen.ScreenDefinition

@groovy.transform.CompileStatic
class ScreenDefinition
extends java.lang.Object

Nested Class Summary

Nested classes
Modifiers	Name	Description
`static class`	`ScreenDefinition.ActionsTransitionItem`
`static class`	`ScreenDefinition.FormSavedFindsTransitionItem`	Special automatic transition to manage Saved Finds for form-list with saved-finds=true
`static class`	`ScreenDefinition.FormSelectColumnsTransitionItem`	Special automatic transition to save results of Select Columns form for form-list with select-columns=true
`static class`	`ScreenDefinition.ParameterItem`
`static class`	`ScreenDefinition.ResponseItem`
`static class`	`ScreenDefinition.ScreenDocumentTransitionItem`	Special automatic transition to get content of a ScreenDocument by docIndex
`static class`	`ScreenDefinition.SubscreensItem`
`static class`	`ScreenDefinition.SubscreensItemComparator`
`static class`	`ScreenDefinition.TransitionItem`

Field Summary

Fields
Modifiers	Name	Description
`protected boolean`	`allowExtraPath`
`protected XmlAction`	`alwaysActions`
`protected java.lang.String`	`defaultSubscreensItem`
`protected java.util.Set<java.lang.String>`	`dependsOnScreenLocations`
`protected java.util.Map<java.lang.String, ScreenForm>`	`formByName`
`protected boolean`	`hasRequired`
`protected boolean`	`hasTabMenu`
`protected java.lang.String`	`location`
`protected java.util.Map<java.lang.String, java.lang.String>`	`macroTemplateByRenderMode`
`protected java.util.Map<java.lang.String, ParameterItem>`	`parameterByName`
`protected XmlAction`	`preActions`
`protected java.util.Set<java.lang.String>`	`renderModes`
`protected ScreenSection`	`rootSection`
`protected java.lang.String`	`screenName`
`protected MNode`	`screenNode`
`protected java.util.Map<java.lang.String, ScreenSection>`	`sectionByName`
`protected java.util.Set<java.lang.String>`	`serverStatic`
`protected ScreenFacadeImpl`	`sfi`
`protected boolean`	`standalone`
`protected java.util.Map<java.lang.String, ResourceReference>`	`subContentRefByPath`
`protected java.util.Map<java.lang.String, SubscreensItem>`	`subscreensByName`
`protected java.util.ArrayList<SubscreensItem>`	`subscreensItemsSorted`
`protected java.util.ArrayList<SubscreensItem>`	`subscreensNoSubPath`
`protected MNode`	`subscreensNode`
`protected java.util.Map<java.lang.String, TransitionItem>`	`transitionByName`
`protected java.util.Map<java.lang.String, ScreenTree>`	`treeByName`
`protected MNode`	`webSettingsNode`

Properties Summary

Properties
Type	Name and description
`long`	`screenLoadedTime`
`java.lang.Long`	`sourceLastModified`

Constructor Summary

Constructors
Constructor and description
`ScreenDefinition (ScreenFacadeImpl sfi, MNode screenNode, java.lang.String location)`

Methods Summary

Methods
Type Params	Return Type	Name and description
	`java.util.ArrayList<java.lang.String>`	`findSubscreenPath(java.util.ArrayList<java.lang.String> remainingPathNameList)`
	`java.util.ArrayList<ScreenForm>`	`getAllForms()`
	`java.util.Collection<TransitionItem>`	`getAllTransitions()`
	`XmlAction`	`getAlwaysActions()`
	`java.lang.String`	`getDefaultMenuName()`
	`java.lang.String`	`getDefaultSubscreensItem()`
	`ScreenForm`	`getForm(java.lang.String formName)`
	`java.lang.String`	`getLocation()`
	`java.lang.String`	`getMacroTemplateLocation(java.lang.String renderMode)` Get macro template location specific to screen from marco-template elements
	`java.util.ArrayList<SubscreensItem>`	`getMenuSubscreensItems()`
	`java.util.Map<java.lang.String, ParameterItem>`	`getParameterMap()`
	`XmlAction`	`getPreActions()`
	`static java.lang.String`	`getPrettyMenuName(java.lang.String menuName, java.lang.String location, ExecutionContextFactoryImpl ecfi)`
	`ScreenSection`	`getRootSection()`
	`java.util.List<java.util.Map<java.lang.String, java.lang.Object>>`	`getScreenDocumentInfoList()`
	`java.lang.String`	`getScreenName()`
	`MNode`	`getScreenNode()`
	`ScreenSection`	`getSection(java.lang.String sectionName)`
	`ResourceReference`	`getSubContentRef(java.util.List<java.lang.String> pathNameList)`
	`ScreenDefinition.SubscreensItem`	`getSubscreensItem(java.lang.String name)`
	`java.util.ArrayList<SubscreensItem>`	`getSubscreensItemsSorted()`
	`java.util.ArrayList<SubscreensItem>`	`getSubscreensNoSubPath()`
	`MNode`	`getSubscreensNode()`
	`TransitionItem`	`getTransitionItem(java.lang.String name, java.lang.String method)`
	`ScreenTree`	`getTree(java.lang.String treeName)`
	`MNode`	`getWebSettingsNode()`
	`boolean`	`hasRequiredParameters()`
	`boolean`	`hasTabMenu()`
	`boolean`	`hasTransition(java.lang.String name)`
	`boolean`	`isServerStatic(java.lang.String renderMode)`
	`boolean`	`isStandalone()`
	`java.util.List<java.lang.String>`	`nestedNoReqParmLocations(java.lang.String currentPath, java.util.Set<java.lang.String> screensToSkip)`
	`void`	`populateSubscreens()`
	`void`	`pullSectionInclude(MNode sectionIncludeNode)`
	`void`	`render(ScreenRenderImpl sri, boolean isTargetScreen)`
	`java.lang.String`	`toString()`

Inherited Methods Summary

Inherited Methods
Methods inherited from class	Name
`class java.lang.Object`	`java.lang.Object#wait(long), java.lang.Object#wait(long, int), java.lang.Object#wait(), java.lang.Object#equals(java.lang.Object), java.lang.Object#toString(), java.lang.Object#hashCode(), java.lang.Object#getClass(), java.lang.Object#notify(), java.lang.Object#notifyAll()`

- Field Detail
  - protected boolean allowExtraPath
  - protected XmlAction alwaysActions
  - protected java.lang.String defaultSubscreensItem
  - protected final java.util.Set<java.lang.String> dependsOnScreenLocations
  - protected java.util.Map<java.lang.String, ScreenForm> formByName
  - protected boolean hasRequired
  - protected boolean hasTabMenu
  - @java.lang.SuppressWarnings(value: GrFinalVariableAccess) protected final java.lang.String location
  - protected java.util.Map<java.lang.String, java.lang.String> macroTemplateByRenderMode
  - protected java.util.Map<java.lang.String, ParameterItem> parameterByName
  - protected XmlAction preActions
  - protected java.util.Set<java.lang.String> renderModes
  - protected ScreenSection rootSection
  - @java.lang.SuppressWarnings(value: GrFinalVariableAccess) protected final java.lang.String screenName
  - @java.lang.SuppressWarnings(value: GrFinalVariableAccess) protected final MNode screenNode
  - protected java.util.Map<java.lang.String, ScreenSection> sectionByName
  - protected java.util.Set<java.lang.String> serverStatic
  - @java.lang.SuppressWarnings(value: GrFinalVariableAccess) protected final ScreenFacadeImpl sfi
  - protected boolean standalone
  - protected java.util.Map<java.lang.String, ResourceReference> subContentRefByPath
  - protected java.util.Map<java.lang.String, SubscreensItem> subscreensByName
  - protected java.util.ArrayList<SubscreensItem> subscreensItemsSorted
  - protected java.util.ArrayList<SubscreensItem> subscreensNoSubPath
  - @java.lang.SuppressWarnings(value: GrFinalVariableAccess) protected final MNode subscreensNode
  - protected java.util.Map<java.lang.String, TransitionItem> transitionByName
  - protected java.util.Map<java.lang.String, ScreenTree> treeByName
  - @java.lang.SuppressWarnings(value: GrFinalVariableAccess) protected final MNode webSettingsNode
- Property Detail
  - @java.lang.SuppressWarnings(value: GrFinalVariableAccess) final long screenLoadedTime
  - java.lang.Long sourceLastModified
- Constructor Detail
  - ScreenDefinition(ScreenFacadeImpl sfi, MNode screenNode, java.lang.String location)
- Method Detail
  - java.util.ArrayList<java.lang.String> findSubscreenPath(java.util.ArrayList<java.lang.String> remainingPathNameList)
  - java.util.ArrayList<ScreenForm> getAllForms()
  - java.util.Collection<TransitionItem> getAllTransitions()
  - XmlAction getAlwaysActions()
  - java.lang.String getDefaultMenuName()
  - java.lang.String getDefaultSubscreensItem()
  - ScreenForm getForm(java.lang.String formName)
  - java.lang.String getLocation()
  - java.lang.String getMacroTemplateLocation(java.lang.String renderMode)
    
    Get macro template location specific to screen from marco-template elements
  - java.util.ArrayList<SubscreensItem> getMenuSubscreensItems()
  - java.util.Map<java.lang.String, ParameterItem> getParameterMap()
  - XmlAction getPreActions()
  - static java.lang.String getPrettyMenuName(java.lang.String menuName, java.lang.String location, ExecutionContextFactoryImpl ecfi)
  - ScreenSection getRootSection()
  - java.util.List<java.util.Map<java.lang.String, java.lang.Object>> getScreenDocumentInfoList()
  - java.lang.String getScreenName()
  - MNode getScreenNode()
  - ScreenSection getSection(java.lang.String sectionName)
  - ResourceReference getSubContentRef(java.util.List<java.lang.String> pathNameList)
  - ScreenDefinition.SubscreensItem getSubscreensItem(java.lang.String name)
  - java.util.ArrayList<SubscreensItem> getSubscreensItemsSorted()
  - java.util.ArrayList<SubscreensItem> getSubscreensNoSubPath()
  - MNode getSubscreensNode()
  - TransitionItem getTransitionItem(java.lang.String name, java.lang.String method)
  - ScreenTree getTree(java.lang.String treeName)
  - MNode getWebSettingsNode()
  - boolean hasRequiredParameters()
  - boolean hasTabMenu()
  - boolean hasTransition(java.lang.String name)
  - boolean isServerStatic(java.lang.String renderMode)
  - boolean isStandalone()
  - java.util.List<java.lang.String> nestedNoReqParmLocations(java.lang.String currentPath, java.util.Set<java.lang.String> screensToSkip)
  - void populateSubscreens()
  - void pullSectionInclude(MNode sectionIncludeNode)
  - void render(ScreenRenderImpl sri, boolean isTargetScreen)
  - @java.lang.Override java.lang.String toString()

Groovy Documentation

[Groovy] Class ScreenDefinition

Nested Class Summary

Field Summary

Properties Summary

Constructor Summary

Methods Summary

Inherited Methods Summary

Field Detail

protected boolean allowExtraPath

protected XmlAction alwaysActions

protected java.lang.String defaultSubscreensItem

protected final java.util.Set<java.lang.String> dependsOnScreenLocations

protected java.util.Map<java.lang.String, ScreenForm> formByName

protected boolean hasRequired

protected boolean hasTabMenu

@java.lang.SuppressWarnings(value: GrFinalVariableAccess) protected final java.lang.String location

protected java.util.Map<java.lang.String, java.lang.String> macroTemplateByRenderMode

protected java.util.Map<java.lang.String, ParameterItem> parameterByName

protected XmlAction preActions

protected java.util.Set<java.lang.String> renderModes

protected ScreenSection rootSection

@java.lang.SuppressWarnings(value: GrFinalVariableAccess) protected final java.lang.String screenName

@java.lang.SuppressWarnings(value: GrFinalVariableAccess) protected final MNode screenNode

protected java.util.Map<java.lang.String, ScreenSection> sectionByName

protected java.util.Set<java.lang.String> serverStatic

@java.lang.SuppressWarnings(value: GrFinalVariableAccess) protected final ScreenFacadeImpl sfi

protected boolean standalone

protected java.util.Map<java.lang.String, ResourceReference> subContentRefByPath

protected java.util.Map<java.lang.String, SubscreensItem> subscreensByName

protected java.util.ArrayList<SubscreensItem> subscreensItemsSorted

protected java.util.ArrayList<SubscreensItem> subscreensNoSubPath

@java.lang.SuppressWarnings(value: GrFinalVariableAccess) protected final MNode subscreensNode

protected java.util.Map<java.lang.String, TransitionItem> transitionByName

protected java.util.Map<java.lang.String, ScreenTree> treeByName

@java.lang.SuppressWarnings(value: GrFinalVariableAccess) protected final MNode webSettingsNode

Property Detail

@java.lang.SuppressWarnings(value: GrFinalVariableAccess) final long screenLoadedTime

java.lang.Long sourceLastModified

Constructor Detail

ScreenDefinition(ScreenFacadeImpl sfi, MNode screenNode, java.lang.String location)

Method Detail

java.util.ArrayList<java.lang.String> findSubscreenPath(java.util.ArrayList<java.lang.String> remainingPathNameList)

java.util.ArrayList<ScreenForm> getAllForms()

java.util.Collection<TransitionItem> getAllTransitions()

XmlAction getAlwaysActions()

java.lang.String getDefaultMenuName()

java.lang.String getDefaultSubscreensItem()

ScreenForm getForm(java.lang.String formName)

java.lang.String getLocation()

java.lang.String getMacroTemplateLocation(java.lang.String renderMode)

java.util.ArrayList<SubscreensItem> getMenuSubscreensItems()

java.util.Map<java.lang.String, ParameterItem> getParameterMap()

XmlAction getPreActions()

static java.lang.String getPrettyMenuName(java.lang.String menuName, java.lang.String location, ExecutionContextFactoryImpl ecfi)

ScreenSection getRootSection()

java.util.List<java.util.Map<java.lang.String, java.lang.Object>> getScreenDocumentInfoList()

java.lang.String getScreenName()

MNode getScreenNode()

ScreenSection getSection(java.lang.String sectionName)

ResourceReference getSubContentRef(java.util.List<java.lang.String> pathNameList)

ScreenDefinition.SubscreensItem getSubscreensItem(java.lang.String name)

java.util.ArrayList<SubscreensItem> getSubscreensItemsSorted()

java.util.ArrayList<SubscreensItem> getSubscreensNoSubPath()

MNode getSubscreensNode()

TransitionItem getTransitionItem(java.lang.String name, java.lang.String method)

ScreenTree getTree(java.lang.String treeName)

MNode getWebSettingsNode()

boolean hasRequiredParameters()

boolean hasTabMenu()

boolean hasTransition(java.lang.String name)

boolean isServerStatic(java.lang.String renderMode)

boolean isStandalone()

java.util.List<java.lang.String> nestedNoReqParmLocations(java.lang.String currentPath, java.util.Set<java.lang.String> screensToSkip)

void populateSubscreens()

void pullSectionInclude(MNode sectionIncludeNode)

void render(ScreenRenderImpl sri, boolean isTargetScreen)

@java.lang.Override java.lang.String toString()