Class ClientProps

java.lang.Object
com.iizix.prop.GProp<GProp<?>[]>
com.iizix.prop.PropCnr
com.iizix.prop.ClientProps
All Implemented Interfaces:
EventListener, IGProp<GProp<?>[]>, IPropCnr, IPropRoot, Cloneable
public final class ClientProps extends PropCnr implements IPropRoot
This client property is a container that holds everything a client/server needs in order to establish communication with the other party, and information about themselves (such as environment).

The client properties has the following properties:

  • $apps - AppsProps
  • $environment - EnvProps
Author:
Christopher Mindus

  • Field Details

    • envProps

      protected EnvProps envProps
      The environment properties.

  • Constructor Details

    • ClientProps

      protected ClientProps()
      Creates the client properties without a name. The name must be set in all cases using the setPropertyAtom call.

  • Method Details

    • getEnvironment

      public EnvProps getEnvironment()
      Gets the environment properties.
      Specified by:
      getEnvironment in interface IGProp<GProp<?>[]>
      Overrides:
      getEnvironment in class GProp<GProp<?>[]>
      Returns:
      The EnvProps for the client environment.

    • getServerEnv

      public StringMapProp getServerEnv()
      Gets the server environment properties.
      Returns:
      StringMapProp for the server environment.

    • getClientEnv

      public StringMapProp getClientEnv()
      Gets the client environment properties.
      Returns:
      StringMapProp for the server environment.

    • getPropRootPropMgr

      public final PropMgr getPropRootPropMgr()
      Gets the Property Manager used for communication for the root container. If this is not the root container, the parent function is called upwards in tree.
      Specified by:
      getPropRootPropMgr in interface IGProp<GProp<?>[]>
      Specified by:
      getPropRootPropMgr in interface IPropRoot
      Overrides:
      getPropRootPropMgr in class GProp<GProp<?>[]>
      Returns:
      The Property Manager, or null when not attached to a root.

    • isPropRoot

      public final boolean isPropRoot()
      Checks if this is a root property container. It is overridden by the root property.
      Specified by:
      isPropRoot in interface IGProp<GProp<?>[]>
      Overrides:
      isPropRoot in class GProp<GProp<?>[]>
      Returns:
      true for the root, false otherwise.

    • isPropReferenceTreeValid

      public final boolean isPropReferenceTreeValid()
      Verifies if the tree is valid for reference creation. This method is typically overridden in a root property that has a Property Manager owner that in turn is checked for a particular configuration (e.g. Client-related references such as LabelForReference that does not create references when communicating).

      The code implementation for a root property should be:

          return (!isDisposed() && getPropRootPropMgr()!=null);

      Specified by:
      isPropReferenceTreeValid in interface IGProp<GProp<?>[]>
      Specified by:
      isPropReferenceTreeValid in interface IPropRoot
      Overrides:
      isPropReferenceTreeValid in class GProp<GProp<?>[]>
      Returns:
      true if the root property manager is found, false otherwise.

    • isPropRootTreeModificationsAllowed

      protected final boolean isPropRootTreeModificationsAllowed()
      Checking if a root property is allowed to be modified even after loading has completed.
      Overrides:
      isPropRootTreeModificationsAllowed in class GProp<GProp<?>[]>
      Returns:
      Flag indicating that the tree of properties below this container can be modified.

    • getRootName

      public String getRootName(GProp<?> requestor)
      Gets the name of the root container as in the Designer "module:".
      Overrides:
      getRootName in class GProp<GProp<?>[]>
      Parameters:
      requestor - The requestor property.
      Returns:
      The application root returns "{CLIENT_ROOT}:", because each Module project property container is a root itself, and this name is illegal for Atoms and paths.

    • onEventSelf

      public void onEventSelf(GEvent event)
      Checks for self-event to queue remote events.
      Specified by:
      onEventSelf in interface IGProp<GProp<?>[]>
      Overrides:
      onEventSelf in class GProp<GProp<?>[]>
      Parameters:
      event - The property event.

    • setUIThemes

      public boolean setUIThemes(String themes)
      Sets the UI themes for desktop and mobile.
      Parameters:
      themes - The themes, comma separated "desktop,mobile".
      Returns:
      true for success, false for no change or failure.

    • setUIScheme

      public boolean setUIScheme(String scheme)
      Sets the UI theme scheme: the shipped theme family and the mode the client shows (UISchemes), sent as the $scheme property and applied by iz/uischeme.js. The Panel Editor sends the Designer pages their choice this way, and the server relays an iiziRun launcher's choice.
      Parameters:
      scheme - The scheme as "family/mode", e.g. "iizi/dark".
      Returns:
      true for success, false for no change or failure.

    • setUISchemeModes

      public boolean setUISchemeModes(String modes)
      Sets the modes the application allows the client to show (UISchemes.modesValue(int)), sent as the $schemeModes property and applied by iz/uischeme.js, which then resolves a choice the application does not allow to the mode it does, without changing the choice the device keeps (order CC-THEME-DARK-V5).
      Parameters:
      modes - "light", "dark", or the empty string for both.
      Returns:
      true for success, false for no change or failure.

    • setPaletteCSS

      public boolean setPaletteCSS(String css)
      Sets the application's palette block: the app's palette colors and families as CSS custom properties (AppPaletteCSS), sent as the $palette property and installed by iz/ClientProps.js in one style element at the app location, after the shipped theme sheet. Generated at session start; set again after a palette edit, when only a changed block travels.
      Parameters:
      css - The block.
      Returns:
      true for success, false for no change or failure.

    • getPaletteCSS

      public String getPaletteCSS()
      Gets the application's palette block.
      Returns:
      The block, or null when none is set.

    • assignModuleProvider

      public boolean assignModuleProvider(IModuleProjectPropProvider modulePropProvider)
      Assigns a module project property provider.
      Parameters:
      modulePropProvider - The provider, or null to clear it.
      Returns:
      true for changed, false for no change.

    • getProjectName

      public String getProjectName(GProp<?> requestor, String alias)
      Gets the project name from an alias, the alias does NOT begin with "*".

      Without a module provider there are no aliases: the answer is null. The default of GProp is for a container that is not a root; on this root it asserted (with assertions enabled) and answered null anyway.

      Overrides:
      getProjectName in class GProp<GProp<?>[]>
      Parameters:
      requestor - The requestor.
      alias - The alias name.
      Returns:
      The project name for the alias, or null if not found.

    • getAliasName

      public String getAliasName(GProp<?> requestor, String projectName)
      Gets an alias name for a project name, the alias does NOT begin with "*".

      The module provider has no reverse mapping (IModuleProjectPropProvider maps an alias to a project name only), so this root never answers an alias: null. The Designer's project root answers it; the default of GProp asserted on this root (with assertions enabled) and answered null anyway.

      Overrides:
      getAliasName in class GProp<GProp<?>[]>
      Parameters:
      requestor - The requestor.
      projectName - The project name (without ending ':').
      Returns:
      null, always: not found.

    • getRootFromName

      public PropCnr getRootFromName(GProp<?> requestor, String module)
      Gets the module root for a name. In the Editor, the module is the project, and that root container is returned. In the Server, the module doesn't matter, so the real root returns itself.

      When running with assertions, this call throws an assertion error by default, showing that the call is directed to a non-root property container.

      Overrides:
      getRootFromName in class GProp<GProp<?>[]>
      Parameters:
      requestor - The requestor.
      module - The module name (without colon), i.e. the project name in the Designer.

      Without a module provider only "{CLIENT_ROOT}" is known: any other module answers null. The default of GProp is for a container that is not a root; on this root it asserted (with assertions enabled) and answered null anyway.

      Returns:
      The root property container, or null if this container is not the root, or if the module name is not found. The default implementation returns null.