Class PropMgrInfoProviderAdapter

java.lang.Object
com.iizix.prop.PropMgrInfoProviderAdapter
All Implemented Interfaces:
IPropMgrInfoProvider, IKStringInfoProvider

public abstract class PropMgrInfoProviderAdapter extends Object implements IPropMgrInfoProvider
Abstract adapter for the Property Manager Information Provider.
Author:
Christopher Mindus
  • Constructor Details

    • PropMgrInfoProviderAdapter

      public PropMgrInfoProviderAdapter()
  • Method Details

    • getHTTPServer

      public String getHTTPServer()
      Gets the HTTP Server string prefix including port.
      Specified by:
      getHTTPServer in interface IKStringInfoProvider
      Returns:
      The "HTTP[S]//server[:port]" String or null for none. This adapter returns "".
    • getImageTarget

      public abstract IImageTarget getImageTarget(String ref)
      Gets the image reference. This method must be implemented by subclasses.
      Specified by:
      getImageTarget in interface IKStringInfoProvider
      Parameters:
      ref - The image definition reference string.
      Returns:
      The image found, or null if not found.
    • doAddReference

      public boolean doAddReference()
      Gets the flag for adding the reference string in an attribute when editing the KString.
      Specified by:
      doAddReference in interface IKStringInfoProvider
      Returns:
      false, the adapter always returns false.
    • cacheSVG

      public final int cacheSVG(String svgString)
      Adds the SVG image information as being sent to the client.
      Specified by:
      cacheSVG in interface IPropMgrInfoProvider
      Parameters:
      svgString - The SVG string.
      Returns:
      The cached index value for the SVG string. A negative value indicates that it needs sending to the client, whereas a positive means only the index is required to be sent. A return value of zero is an error and means not to send it to client at all.
    • cacheCustomCSS

      public final boolean cacheCustomCSS(String url)
      Caches the custom CSS URL.
      Specified by:
      cacheCustomCSS in interface IPropMgrInfoProvider
      Parameters:
      url - The URL of the Custom CSS.
      Returns:
      Flag indicating the URL needs to be sent to client when true or if is already cached on the client side false.