Package com.iizix.text

Interface IKStringValuePropHolder<PROP_VALUE>

Type Parameters:
PROP_VALUE - The property value, e.g. KString, KTooltip or GBadge.
All Superinterfaces:
IGProp<PROP_VALUE>, IKStringHolder<PROP_VALUE>, IKStringInfoProvider, IReferencingGProp, ITextExternalizableProp<PROP_VALUE>
All Known Implementing Classes:
BadgeProp, KStringProp, PatternProp, PlainKStringProp, TooltipProp
public interface IKStringValuePropHolder<PROP_VALUE> extends IKStringHolder<PROP_VALUE>, IKStringInfoProvider, ITextExternalizableProp<PROP_VALUE>
Interface containing default code for the KString holder, KString information provider and externalizable KString support.
Author:
Christopher Mindus

  • Method Details

    • getHTTPServer

      default 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.

    • getImageTarget

      default IImageTarget getImageTarget(String ref)
      Gets the image reference.
      Specified by:
      getImageTarget in interface IKStringInfoProvider
      Parameters:
      ref - The image definition reference string.
      Returns:
      The image found, or null if not found.

    • doAddReference

      default boolean doAddReference()
      Gets the flag for adding the reference string in an attribute when editing the KString in a rich text editor.
      Specified by:
      doAddReference in interface IKStringInfoProvider
      Returns:
      true for the Designer (will add additional parameters for the rich text editor), false for normal processing.

    • shouldResolve

      default boolean shouldResolve()
      Flag indicating the "real" resolved string should be returned. This value is true for the runtime client when in "real run mode".
      Specified by:
      shouldResolve in interface IKStringInfoProvider
      Returns:
      true to resolve all references, false if inside e.g. the Designer.

    • getResolveReferenceProperty

      default GProp<?> getResolveReferenceProperty()
      Gets the property used for references look-up's.
      Specified by:
      getResolveReferenceProperty in interface IKStringInfoProvider
      Returns:
      The property to use for reference property look-up.

    • getDPR

      default double getDPR()
      Gets the device pixel ratio.
      Specified by:
      getDPR in interface IKStringInfoProvider
      Returns:
      The device pixel ratio, default 1.0.

    • getTargetLanguageCode

      default String getTargetLanguageCode()
      Gets the language code to use.
      Specified by:
      getTargetLanguageCode in interface IKStringInfoProvider
      Returns:
      The language code, or null for default.

    • getResourcePrefix

      default 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.
      Specified by:
      getResourcePrefix in interface IKStringInfoProvider
      Returns:
      The resource prefix string, "/$" by default, but "/$APPID/" for the Server,' where APPID is the application being run by the client.

    • installFont

      default boolean installFont(String fontFamily)
      Installs the font families as specified by the font family.
      Specified by:
      installFont in interface IKStringInfoProvider
      Parameters:
      fontFamily - The font family or families.
      Returns:
      true for success, false if the remote part doesn't support installation, e.g. in a preview browser.

    • installFonts

      default boolean installFonts(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.
      Specified by:
      installFonts in interface IKStringInfoProvider
      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.

    • getExternalizableKString

      default KString getExternalizableKString()
      Returns if KString if it is a candidate for externalizing its text to a text table.
      Specified by:
      getExternalizableKString in interface ITextExternalizableProp<PROP_VALUE>
      Returns:
      The KString that can be externalized, or null if not.