Interface InlinePreviewConstraints
@NonExtendable
public interface InlinePreviewConstraints
Configuration interface for
project specific inline preview constraints.- Since:
- 4.2.20
- See Also:
-
Nested Class Summary
Nested ClassesModifier and TypeInterfaceDescriptionstatic enumThe default application engines file name extensions used for (bound to) a specific engine type.static enumInline preview control option -
Method Summary
Modifier and TypeMethodDescriptionReturns a comma separated list file name extensions.Returns a comma separated list file name extensions.Returns the default respectively fixedcontent highlighting mode, depending on return value ofisInlinePreviewControlAdjustable().Returns a comma separated list file name extensions.Returns a comma separated list file name extensions.floatReturns the browsers default respectively fixed zoom factor, depending on return value ofisZoomFactorAdjustable().booleanIndicated the activation state of the graphics engine for this project.booleanReturnstrueif inline preview for media is enabled,falseotherwise.booleanReturnstrueif the content highlighting mode is adjustable by user,falseotherwise.booleanReturnstrueif inline preview for contents is enabled,falseotherwise.booleanReturnstrueif the browsers zoom factor is adjustable by user,falseotherwise.voidsetBrowserEngineFileExtensions(String fileExtensions) Set the file name extensions bound to the integrated office application engine.voidsetGraphicsEngineActive(boolean activate) Activate the internal graphics engine.voidsetGraphicsEngineFileExtensions(String fileExtensions) Set the file name extensions bound to the integrated office application engine.voidsetInlineMediaPreviewEnabled(boolean enable) Providetrueif inline preview for media should be enabled,falseotherwise.voidsetInlinePreviewControlAdjustable(boolean adjustable) Providetrueif the content highlighting mode should be adjustable by user,falseotherwise.voidProvide the default respectively fixedcontent highlighting mode.
Note: depends on return value ofisInlinePreviewControlAdjustable().voidsetInlinePreviewEnabled(boolean enable) Providetrueif inline preview for contents should be enabled,falseotherwise.voidsetMediaPlayerFileExtensions(String fileExtensions) Set the file name extensions bound to the integrated office application engine.voidsetTextEditorFileExtensions(String fileExtensions) "png,jpg,jpeg,bmp,gif,psd" Set the file name extensions bound to the integrated office application engine.voidsetZoomFactor(float zoomFactor) Provide the browsers default respectively fixed zoom factor.
Note: depends on return value ofisZoomFactorAdjustable().voidsetZoomFactorAdjustable(boolean adjustable) Providetrueif the browsers zoom factor should be adjustable by user,falseotherwise.
-
Method Details
-
isInlinePreviewEnabled
boolean isInlinePreviewEnabled()Returnstrueif inline preview for contents is enabled,falseotherwise.- Returns:
trueif enabled otherwisefalse- Since:
- 4.2.20
-
setInlinePreviewEnabled
void setInlinePreviewEnabled(boolean enable) Providetrueif inline preview for contents should be enabled,falseotherwise.- Parameters:
enable-- Since:
- 4.2.20
-
isInlineMediaPreviewEnabled
boolean isInlineMediaPreviewEnabled()Returnstrueif inline preview for media is enabled,falseotherwise.- Returns:
trueif enabled otherwisefalse- Since:
- 4.2.400
-
setInlineMediaPreviewEnabled
void setInlineMediaPreviewEnabled(boolean enable) Providetrueif inline preview for media should be enabled,falseotherwise.- Parameters:
enable-- Since:
- 4.2.400
-
isZoomFactorAdjustable
boolean isZoomFactorAdjustable()Returnstrueif the browsers zoom factor is adjustable by user,falseotherwise.- Returns:
trueif enabled otherwisefalse- Since:
- 4.2.20
-
setZoomFactorAdjustable
void setZoomFactorAdjustable(boolean adjustable) Providetrueif the browsers zoom factor should be adjustable by user,falseotherwise.- Parameters:
adjustable-- Since:
- 4.2.20
-
getZoomFactor
float getZoomFactor()Returns the browsers default respectively fixed zoom factor, depending on return value ofisZoomFactorAdjustable().- Returns:
trueif enabled otherwisefalse- Since:
- 4.2.20
-
setZoomFactor
void setZoomFactor(float zoomFactor) Provide the browsers default respectively fixed zoom factor.
Note: depends on return value ofisZoomFactorAdjustable().- Parameters:
zoomFactor-- Since:
- 4.2.20
-
isInlinePreviewControlAdjustable
boolean isInlinePreviewControlAdjustable()Returnstrueif the content highlighting mode is adjustable by user,falseotherwise.- Returns:
trueif enabled otherwisefalse- Since:
- 4.2.20
- See Also:
-
setInlinePreviewControlAdjustable
void setInlinePreviewControlAdjustable(boolean adjustable) Providetrueif the content highlighting mode should be adjustable by user,falseotherwise.- Parameters:
adjustable-- Since:
- 4.2.20
- See Also:
-
getInlinePreviewControlOption
InlinePreviewConstraints.InlinePreviewControlOption getInlinePreviewControlOption()Returns the default respectively fixedcontent highlighting mode, depending on return value ofisInlinePreviewControlAdjustable().- Returns:
- the options object
- Since:
- 4.2.20
-
setInlinePreviewControlOption
Provide the default respectively fixedcontent highlighting mode.
Note: depends on return value ofisInlinePreviewControlAdjustable().- Parameters:
option-- Since:
- 4.2.20
-
setBrowserEngineFileExtensions
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
"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
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
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
-
isGraphicsEngineActive
boolean isGraphicsEngineActive()Indicated the activation state of the graphics engine for this project.- Returns:
trueif activated otherwisefalse- Since:
- 4.2.400
-
setGraphicsEngineActive
void setGraphicsEngineActive(boolean activate) Activate the internal graphics engine.- Parameters:
activate-truefor activate otherwisefalse- Since:
- 4.2.400
-