Class RichTextEditorDialog

  • All Implemented Interfaces:
    IKStringInfoProvider

    public class RichTextEditorDialog
    extends org.eclipse.swt.widgets.Dialog
    implements IKStringInfoProvider
    Rich text editor dialog box.
    Author:
    Christopher Mindus
    • Constructor Summary

      Constructors 
      Constructor Description
      RichTextEditorDialog​(org.eclipse.swt.widgets.Shell parent, ModuleModel model, KString ks, java.lang.Boolean useTags)
      Create the dialog.
    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      boolean doAddReference()
      Gets the flag for adding the reference string in an attribute when editing the KString.
      double getDPR()
      Gets the device pixel ratio.
      java.lang.String getHTTPServer()
      Gets the HTTP Server string prefix including port.
      IImageTarget getImageTarget​(java.lang.String ref)
      Gets the image reference.
      GProp<?> getResolveReferenceProperty()
      Gets the property used for references look-up's.
      java.lang.String getResourcePrefix()
      Gets the base reference name for the resource, typically an image, for the Server or the Designer.
      java.lang.String getTargetLanguageCode()
      Gets the language code to use.
      boolean installFont​(java.lang.String fontFamily)
      Installs the font families as specified by the font family.
      boolean installFonts​(java.util.List<FontFiles> fontList)
      Installs the font face as specified by the FontFiles instance for the Client Session.
      static boolean isEnabled()
      Flag for RichTextEditorDialog enabled in the code.
      KString open()
      Open the dialog.
      boolean shouldResolve()
      Flag indicating the "real" resolved string should be returned.
      • Methods inherited from class org.eclipse.swt.widgets.Dialog

        checkSubclass, getParent, getStyle, getText, setText
      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    • Constructor Detail

      • RichTextEditorDialog

        public RichTextEditorDialog​(org.eclipse.swt.widgets.Shell parent,
                                    ModuleModel model,
                                    KString ks,
                                    java.lang.Boolean useTags)
        Create the dialog.
    • Method Detail

      • isEnabled

        public static boolean isEnabled()
        Flag for RichTextEditorDialog enabled in the code. Remove this flag and all conditional code around it when completed.
        Returns:
        true if implemented and tested fully, false for now as it is not fully completed/tested.
      • open

        public KString open()
        Open the dialog.
        Returns:
        the gradient.
      • getHTTPServer

        public java.lang.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

        public IImageTarget getImageTarget​(java.lang.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

        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:
        true for the Designer (will add additional parameters for the rich text editor), false for normal processing.
      • shouldResolve

        public 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

        public 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

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

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

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

        public boolean installFont​(java.lang.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

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