Method Detail

• getKStringInfoProviderInstance

  static IKStringInfoProvider getKStringInfoProviderInstance()

  Getting the session's IKStringInfoProvider from the ClientSessionGyro.

  Returns:

  The current client session's IKStringInfoProvider instance, or null if not found.

• getHTTPServer

  java.lang.String getHTTPServer()

  Gets the HTTP Server string prefix including port.

  Returns:

  The "HTTP[S]//server[:port]" String or null for none.

• getImageTarget

  IImageTarget getImageTarget​(java.lang.String ref)

  Gets the image reference.

  Parameters:

  ref - The image definition reference string.

  Returns:

  The image found, or null if not found.

• doAddReference

  boolean doAddReference()

  Gets the flag for adding the reference string in an attribute when editing the KString in a rich text editor.

  Returns:

  true for the Designer (will add additional parameters for the rich text editor), false for normal processing.

• shouldResolve

  boolean shouldResolve()

  Flag indicating the "real" resolved string should be returned. This value is true for the runtime client when in "real run mode".

  Returns:

  true to resolve all references, false if inside e.g. the Designer.

• getResolveReferenceProperty

  GProp<?> getResolveReferenceProperty()

  Gets the property used for references look-up's.

  Returns:

  The property to use for reference property look-up.

• getDPR

  double getDPR()

  Gets the device pixel ratio.

  Returns:

  The device pixel ratio, default 1.0.

• getTargetLanguageCode

  java.lang.String getTargetLanguageCode()

  Gets the language code to use.

  Returns:

  The language code, or null for default.

• getResourcePrefix

  java.lang.String getResourcePrefix()

  Gets the base reference name for the resource, typically an image, for the Server or the Designer. This reference is "/$" (the default in this interface) for the Designer, but should be "/$APPID/" for the Server, where APPID is the application being run by the client. The Server must therefore implement this method and return that string instead.

  Returns:

  The resource prefix string, "/$" by default, but "/$APPID/" for the Server,' where APPID is the application being run by the client.

• installFont

  boolean installFont​(java.lang.String fontFamily)

  Installs the font family specified.

  Parameters:

  fontFamily - The font family.

  Returns:

  true for success, false if the remote part doesn't support installation, e.g. in a preview browser.

• installFonts

  default boolean installFonts​(java.lang.String fontFamilies)

  Installs the font families as specified by the font family.

  Parameters:

  fontFamilies - The font family or families, comma separated.

  Returns:

  true for success, false if the remote part doesn't support installation, e.g. in a preview browser.

• installFonts

  boolean installFonts​(java.util.List<FontFiles> fontList)

  Installs the font face as specified by the FontFiles instance for the Client Session. Once installed, the font family can be used.

  Parameters:

  fontList - The list of font files to install.

  Returns:

  true for success, false if the remote part doesn't support installation, e.g. in a preview browser.