Package de.espirit.firstspirit.access.project

Interface InlinePreviewConstraints

@NonExtendable public interface InlinePreviewConstraints
Configuration interface for project specific inline preview constraints.
Since:
4.2.20
See Also:

  • Method Details

    • isInlinePreviewEnabled

      boolean isInlinePreviewEnabled()
      Returns true if inline preview for contents is enabled, false otherwise.
      Returns:
      true if enabled otherwise false
      Since:
      4.2.20

    • setInlinePreviewEnabled

      void setInlinePreviewEnabled(boolean enable)
      Provide true if inline preview for contents should be enabled, false otherwise.
      Parameters:
      enable -
      Since:
      4.2.20

    • isInlineMediaPreviewEnabled

      boolean isInlineMediaPreviewEnabled()
      Returns true if inline preview for media is enabled, false otherwise.
      Returns:
      true if enabled otherwise false
      Since:
      4.2.400

    • setInlineMediaPreviewEnabled

      void setInlineMediaPreviewEnabled(boolean enable)
      Provide true if inline preview for media should be enabled, false otherwise.
      Parameters:
      enable -
      Since:
      4.2.400

    • isZoomFactorAdjustable

      boolean isZoomFactorAdjustable()
      Returns true if the browsers zoom factor is adjustable by user, false otherwise.
      Returns:
      true if enabled otherwise false
      Since:
      4.2.20

    • setZoomFactorAdjustable

      void setZoomFactorAdjustable(boolean adjustable)
      Provide true if the browsers zoom factor should be adjustable by user, false otherwise.
      Parameters:
      adjustable -
      Since:
      4.2.20

    • getZoomFactor

      float getZoomFactor()
      Returns the browsers default respectively fixed zoom factor, depending on return value of isZoomFactorAdjustable().
      Returns:
      true if enabled otherwise false
      Since:
      4.2.20

    • setZoomFactor

      void setZoomFactor(float zoomFactor)
      Provide the browsers default respectively fixed zoom factor.

      Note: depends on return value of isZoomFactorAdjustable().
      Parameters:
      zoomFactor -
      Since:
      4.2.20

    • isInlinePreviewControlAdjustable

      boolean isInlinePreviewControlAdjustable()
      Returns true if the content highlighting mode is adjustable by user, false otherwise.
      Returns:
      true if enabled otherwise false
      Since:
      4.2.20
      See Also:

    • setInlinePreviewControlAdjustable

      void setInlinePreviewControlAdjustable(boolean adjustable)
      Provide true if the content highlighting mode should be adjustable by user, false otherwise.
      Parameters:
      adjustable -
      Since:
      4.2.20
      See Also:

    • getInlinePreviewControlOption

      InlinePreviewConstraints.InlinePreviewControlOption getInlinePreviewControlOption()
      Returns the default respectively fixed content highlighting mode, depending on return value of isInlinePreviewControlAdjustable().
      Returns:
      the options object
      Since:
      4.2.20

    • setInlinePreviewControlOption

      void setInlinePreviewControlOption(InlinePreviewConstraints.InlinePreviewControlOption option)
      Provide the default respectively fixed content highlighting mode.

      Note: depends on return value of isInlinePreviewControlAdjustable().
      Parameters:
      option -
      Since:
      4.2.20

    • setOfficeEngineFileExtensions

      @Deprecated(forRemoval=true) void setOfficeEngineFileExtensions(String fileExtensions)
      Deprecated, for removal: This API element is subject to removal in a future version.
      since 5.2.191201 - no replacement
      Set the file name extensions bound to the integrated office application engine.

      Important: This method does not have any effect!

      Parameters:
      fileExtensions - a comma separated list of file name extension.
      Since:
      4.2.400

    • getOfficeEngineFileExtensions

      @Deprecated(forRemoval=true) String getOfficeEngineFileExtensions()
      Deprecated, for removal: This API element is subject to removal in a future version.
      since 5.2.191201 - no replacement
      Returns a comma separated list file name extensions.

      Important: This method always returns an empty string ("")!

      Returns:
      The empty string ("")
      Since:
      4.2.400

    • setBrowserEngineFileExtensions

      void setBrowserEngineFileExtensions(String fileExtensions)
      Set the file name extensions bound to the integrated office application engine. A comma separated list (e.g. "html, shtml, htm")
      Parameters:
      fileExtensions - a comma separated list of file name extension.
      Since:
      4.2.400

    • getBrowserEngineFileExtensions

      String getBrowserEngineFileExtensions()
      Returns a comma separated list file name extensions.
      Returns:
      a comma separated string
      Since:
      4.2.400

    • setTextEditorFileExtensions

      void setTextEditorFileExtensions(String fileExtensions)
      "png,jpg,jpeg,bmp,gif,psd" Set the file name extensions bound to the integrated office application engine. A comma separated list (e.g. "css, js, txt, xml, csv, json, as)
      Parameters:
      fileExtensions - a comma separated list of file name extension.
      Since:
      4.2.400

    • getTextEditorFileExtensions

      String getTextEditorFileExtensions()
      Returns a comma separated list file name extensions.
      Returns:
      a comma separated string
      Since:
      4.2.400

    • setMediaPlayerFileExtensions

      void setMediaPlayerFileExtensions(String fileExtensions)
      Set the file name extensions bound to the integrated office application engine. A comma separated list (e.g. "avi, mov, mp3"). Note: The MediaPlayer integration is only on windows systems available.
      Parameters:
      fileExtensions - a comma separated list of file name extension.
      Since:
      4.2.400

    • getMediaPlayerFileExtensions

      String getMediaPlayerFileExtensions()
      Returns a comma separated list file name extensions.
      Returns:
      a comma separated string
      Since:
      4.2.400

    • setGraphicsEngineFileExtensions

      void setGraphicsEngineFileExtensions(String fileExtensions)
      Set the file name extensions bound to the integrated office application engine. A comma separated list (e.g. "png, jpg, jpeg, bmp, gif, psd")
      Parameters:
      fileExtensions - a comma separated list of file name extension.
      Since:
      4.2.400

    • getGraphicsEngineFileExtensions

      String getGraphicsEngineFileExtensions()
      Returns a comma separated list file name extensions.
      Returns:
      a comma separated string
      Since:
      4.2.400

    • setGDataApiCredentials

      @Deprecated(forRemoval=true) void setGDataApiCredentials(Pair<String,String> credentials)
      Deprecated, for removal: This API element is subject to removal in a future version.
      since 5.2.180904 - no replacement
      The google api user credentials used for uploading, downloading, locking remote documents.
      Parameters:
      credentials - the api credentials
      Since:
      4.2.400

    • getGDataAPiCredentials

      @Deprecated(forRemoval=true) Pair<String,String> getGDataAPiCredentials()
      Deprecated, for removal: This API element is subject to removal in a future version.
      since 5.2.180904 - no replacement
      Get the store google api user credentials.
      Returns:
      a key value pair. key=username value=password
      Since:
      4.2.400

    • isGraphicsEngineActive

      boolean isGraphicsEngineActive()
      Indicated the activation state of the graphics engine for this project.
      Returns:
      true if activated otherwise false
      Since:
      4.2.400

    • getGraphicsEngineType

      @Deprecated(forRemoval=true) GraphicsEngineType getGraphicsEngineType()
      Deprecated, for removal: This API element is subject to removal in a future version.
      since 5.2.191201 - no replacement
      Get the per default enabled graphics engine type.

      Important: This method always returns GraphicsEngineType.IMAGEEDITOR!

      Returns:
      String the currently per default set graphics engine
      Since:
      4.2.400

    • setGraphicsEngineActive

      void setGraphicsEngineActive(boolean activate)
      Activate the internal graphics engine.
      Parameters:
      activate - true for activate otherwise false
      Since:
      4.2.400