com.onlyoffice.model.documenteditor.config.editorconfig

Class Customization

java.lang.Object

com.onlyoffice.model.documenteditor.config.editorconfig.Customization

public class Customization
extends Object

Defines the parameters to customize the editor interface so that it looked like your other products (if there are any) and change the presence or absence of the additional buttons, links, change logos and editor owner details.

Field Summary

Fields

Modifier and Type	Field and Description
private Anonymous	anonymous Adds a request for the anonymous name.
private Boolean	autosave Defines if the "Autosave" menu option is enabled or disabled.
private Boolean	chat Deprecated.
private Close	close Defines settings for the cross button to close the editor.
private Boolean	commentAuthorOnly Deprecated.
private Boolean	comments Defines if the "Comments" menu button is displayed or hidden.
private Boolean	compactHeader Defines if the additional action buttons are displayed in the upper part of the editor window header next to the logo ("false") or in the toolbar ("true") making the header more compact.
private Boolean	compactToolbar Defines if the top toolbar type displayed is full ("false") or compact ("true").
private Boolean	compatibleFeatures Defines the use of functionality only compatible with the OOXML format.
private Customer	customer Contains the information which will be displayed in the editor "About" section and visible to all the editor users.
private Features	features Defines the parameters that the user can disable or customize if possible.
private Boolean	feedback Defines if the "Feedback & Support" menu button is displayed or hidden.
private Boolean	forcesave Adds the request for the file force saving to the callback handler when saving the document within the document editing service (e.g.
private Goback	goback Defines settings for the "Open file location" menu button and upper right corner button.
private Boolean	help Defines if the "Help" menu button is displayed or hidden.
private Boolean	hideNotes Defines if the note panel is displayed or hidden on first loading.
private Boolean	hideRightMenu Defines if the right menu is displayed or hidden on first loading.
private Boolean	hideRulers Defines if the editor rulers are displayed or hidden.
private String	integrationMode Defines the mode of embedding editors into the web page.
private Logo	logo Changes the image file at the top left corner of the editor header.
private Boolean	macros Defines if document macros will be automatically run when the editor opens.
private MacrosMode	macrosMode Defines the macros run mode when autostart is enabled.
private Boolean	mentionShare Defines the hint that describes the event after mentions in a comment.
private Boolean	mobileForceView Defines if the mobile document editor is opened in the view/edit mode on launch.
private Boolean	plugins Defines if plugins will be launched and available.
private Review	review Contains the information about the review mode.
private ReviewDisplay	reviewDisplay Deprecated.
private Boolean	showReviewChanges Deprecated.
private Boolean	spellcheck Deprecated.
private Boolean	submitForm Defines if the Submit button is displayed or hidden on the top toolbar.
private Boolean	toolbarHideFileName Defines if the document title is visible on the top toolbar ("false") or hidden ("true").
private Boolean	toolbarNoTabs Deprecated.
private Boolean	trackChanges Deprecated.
private String	uiTheme Defines the editor theme settings.
private Unit	unit Defines the measurement units used on the ruler and in dialog boxes.
private Integer	zoom Defines the document display zoom value measured in percent.

Constructor Summary

Constructors

Constructor and Description
Customization()

Method Summary

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

anonymous

private Anonymous anonymous

Adds a request for the anonymous name.

autosave

private Boolean autosave

Defines if the "Autosave" menu option is enabled or disabled. If set to "false", only "Strict" co-editing mode can be selected, as "Fast" does not work without autosave. The default value is "true".

chat

@Deprecated
private Boolean chat

Deprecated.

Defines if the "Chat" menu button is displayed or hidden. Please note that in case you hide the "Chat" button, the corresponding chat functionality will also be disabled. The default value is "true". Deprecated since version 7.1, please use the document.permissions.chat parameter instead.

close

private Close close

Defines settings for the cross button to close the editor.

commentAuthorOnly

@Deprecated
private Boolean commentAuthorOnly

Deprecated.

Defines if the user can edit and delete only his comments. The default value is "false". Deprecated since version 6.3, please use the document.permissions.editCommentAuthorOnly and document.permissions.deleteCommentAuthorOnly fields instead.

comments

private Boolean comments

Defines if the "Comments" menu button is displayed or hidden. Please note that in case you hide the "Comments" button, the corresponding commenting functionality will be available for viewing only, adding and editing comments will be unavailable. The default value is "true".

compactHeader

private Boolean compactHeader

Defines if the additional action buttons are displayed in the upper part of the editor window header next to the logo ("false") or in the toolbar ("true") making the header more compact. The default value is "false".

compactToolbar

private Boolean compactToolbar

Defines if the top toolbar type displayed is full ("false") or compact ("true"). The default value is "false".

compatibleFeatures

private Boolean compatibleFeatures

Defines the use of functionality only compatible with the OOXML format. For example, do not use comments on the entire document. The default value is "false".

customer

private Customer customer

Contains the information which will be displayed in the editor "About" section and visible to all the editor users.

features

private Features features

Defines the parameters that the user can disable or customize if possible.

feedback

private Boolean feedback

Defines if the "Feedback & Support" menu button is displayed or hidden.

forcesave

private Boolean forcesave

Adds the request for the file force saving to the callback handler when saving the document within the document editing service (e.g. clicking the "Save" button, etc.). The default value is "false".

goback

private Goback goback

Defines settings for the "Open file location" menu button and upper right corner button.

help

private Boolean help

Defines if the "Help" menu button is displayed or hidden. The default value is "true".

hideNotes

private Boolean hideNotes

Defines if the note panel is displayed or hidden on first loading. The default value is "false". This parameter is available for the presentation editor only.

hideRightMenu

private Boolean hideRightMenu

Defines if the right menu is displayed or hidden on first loading. The default value is "false".

hideRulers

private Boolean hideRulers

Defines if the editor rulers are displayed or hidden. This parameter is available for the document and presentation editors. The default value is "false" for the document editor and "true" for presentations.

integrationMode

private String integrationMode

Defines the mode of embedding editors into the web page. The "embed" value disables scrolling to the editor frame when it is loaded as the focus is not captured.

logo

private Logo logo

Changes the image file at the top left corner of the editor header. The recommended image height is 20 pixels.

macros

private Boolean macros

Defines if document macros will be automatically run when the editor opens. The default value is "true". The "false" value hides the macros settings from the user.

macrosMode

private MacrosMode macrosMode

Defines the macros run mode when autostart is enabled. The default value is "warn".

mentionShare

private Boolean mentionShare

Defines the hint that describes the event after mentions in a comment. If "true", a hint indicates that the user will receive a notification and access to the document. If "false", a hint indicates that the user will receive only a notification of the mention. The default value is "true".

mobileForceView

private Boolean mobileForceView

Defines if the mobile document editor is opened in the view/edit mode on launch. The default value is "true".

plugins

private Boolean plugins

Defines if plugins will be launched and available. The default value is "true".

review

private Review review

Contains the information about the review mode.

reviewDisplay

@Deprecated
private ReviewDisplay reviewDisplay

Deprecated.

Defines the review editing mode which will be used when the document is opened for viewing. It will only be available for the document editor if Mode is set to "view". The default value is "original" for viewer and "markup" for editor. Deprecated since version 7.0. Please use the review.reviewDisplay parameter instead.

showReviewChanges

@Deprecated
private Boolean showReviewChanges

Deprecated.

Defines if the review changes panel is automatically displayed or hidden when the editor is loaded. The default value is "false". Deprecated since version 7.0. Please use the review.showReviewChanges parameter instead.

spellcheck

@Deprecated
private Boolean spellcheck

Deprecated.

Defines if the spell checker is automatically switched on or off when the editor is loaded. Spell checker will only be available for the document editor and the presentation editor. The default value is "true". Deprecated since version 7.1. Please use the features.spellcheck parameter instead.

submitForm

private Boolean submitForm

Defines if the Submit button is displayed or hidden on the top toolbar. Button will only be available for the pdf format. The default value is false.

toolbarHideFileName

private Boolean toolbarHideFileName

Defines if the document title is visible on the top toolbar ("false") or hidden ("true"). The default value is "false".

toolbarNoTabs

@Deprecated
private Boolean toolbarNoTabs

Deprecated.

Defines if the top toolbar tabs are distinctly displayed ("false") or only highlighted to see which one is selected ("true"). The default value is "false". Deprecated since version 8.2, please use the Features.tabStyle parameter which is set to line and the Features.tabBackground parameter which is equal to toolbar.

trackChanges

@Deprecated
private Boolean trackChanges

Deprecated.

Defines if the document is opened in the review editing mode ("true") or not ("false") regardless of the document.permissions.review parameter (the review mode is changed only for the current user). If the parameter is undefined, the "document.permissions.review" value is used (for all the document users). Deprecated since version 7.0. Please use the review.trackChanges parameter instead.

uiTheme

private String uiTheme

Defines the editor theme settings. It can be set in two ways: "theme id" - the user sets the theme parameter by its id ("theme-light", "theme-classic-light", "theme-dark", "theme-contrast-dark"), "default theme" - the default dark or light theme value will be set ("default-dark", "default-light"). The default light theme is "theme-classic-light". The first option has higher priority.

unit

private Unit unit

Defines the measurement units used on the ruler and in dialog boxes. The default value is centimeters ("cm").

zoom

private Integer zoom

Defines the document display zoom value measured in percent. Can take values larger than "0". For text documents and presentations it is possible to set this parameter to "-1" (fitting the document to page option) or to "-2" (fitting the document page width to the editor page). The default value is "100".

Constructor Detail

Customization

public Customization()