Class ModuleApp

    • Constructor Detail

      • ModuleApp

        public ModuleApp()
        Creates the applications properties without a name. The name must be set in all cases using the setPropertyAtom call.
      • ModuleApp

        public ModuleApp​(Atom propertyAtom)
        Creates the applications properties with the specified name.
        Parameters:
        propertyAtom - the name of the component, unique within it's parent.
    • Method Detail

      • getDescription

        public java.lang.String getDescription()
        Gets the description of the application.
        Returns:
        The application description, or null if not defined.
      • getTextTable

        public TextTable getTextTable()
        Returns the text table defined for the application.
        Returns:
        The text table, or null if none is defined.
      • getVSReference

        public VSReference getVSReference​(Atom refAtom)
        Gets the VSReference that is initially used as start-up for the application.
        Specified by:
        getVSReference in interface IGProp<GProp<?>[]>
        Overrides:
        getVSReference in class PropCnr
        Parameters:
        refAtom - The property asking for the VSReference.
        Returns:
        The instance of the VSReference or null if unassigned. The returned instance could also be a VSParticipant and should therefore be processed accordingly.
      • createVSReference

        public VSReference createVSReference​(Atom refAtom,
                                             PropCnr[] returnParent)
        Creates a VSReference instance from the container or any parent containers. The method is used in the Designer to create a VirtualSpace connection for VSRelativeReference to look up the VSReference instance in order to resolve the relative path to the target property.

        This method needs to be overridden by subclasses of PropCnr that has a VSReference as property, and *SHOULD* match getVSReference(Atom).

        The default is to re-target the call to the parent container, and if the root, a folder or a file property is reached, null is returned.

        Overrides:
        createVSReference in class PropCnr
        Parameters:
        refAtom - The property asking for the VSReference.
        returnParent - An array of PropCnr [1] that will be filled in with the parent property of the VSRefernce.
        Returns:
        The instance of the VSReference or null if unassigned. The returned instance could also be a VSParticipant and should therefore be processed accordingly.

        For this method, it's a VSReference.

      • getInitialVSComponent

        public VSComponent getInitialVSComponent()
        Gets the component that initially should have focus, or be called (if VSAction is returned).
        Returns:
        The initial focus or action to call, null for none.
      • getAppSessionFocusProvider

        public IAppSessionFocusProvider getAppSessionFocusProvider()
        Gets the class implementing the interface for application focus provider.
        Returns:
        The instance providing custom focus processing, or null for none (i.e. only default processing).
      • getSelectorReference

        public SelectorReference getSelectorReference()
        Gets the selector reference.
      • isSelectorSelected

        public boolean isSelectorSelected​(EnvProps envProps)
        Verifies if the Module Application (project) is selected or not.
        Parameters:
        envProps - The Client Properties for the Client connections.
        Returns:
        true if selected or no selector is defined, false if unselected or the reference is not resolved.
      • getConfiguredLanguages

        public AppLanguages getConfiguredLanguages()
        Gets the configured languages for the Module application.
      • invalidatePossibleThemes

        public void invalidatePossibleThemes()
        Method to invalidate the computed possible themes.
      • computePossibleThemes

        public GThemes computePossibleThemes()
        Lengthy helper function to compute the possible themes for a module application.

        Once calculated in the server, the value never changes. In the designer, it needs recomputing only when a new panels are added, moved, removed, has theme changes or folders changed/removed with theme masks.

        Returns:
        The return value is a mask of the possible themes.
      • getDefaultThemes

        public GThemes getDefaultThemes()
        Gets the default themes to use for desktop and mobile.
        Returns:
        The theme mask, potentially excluding desktop or mobile!
      • getApplicationThemes

        public GThemes getApplicationThemes()
        Gets the application themes to use for desktop and mobile that are supported.
        Returns:
        The theme mask, generally both desktop and mobile, never null.