com.onlyoffice.model.documenteditor.config

Class EditorConfig

java.lang.Object

com.onlyoffice.model.documenteditor.config.EditorConfig

public class EditorConfig
extends Object

Defines the editor interface parameters.

Field Summary

Fields

Modifier and Type	Field and Description
private Object	actionLink Specifies the data received from the document editing service using the "onMakeActionLink" event or the "onRequestSendNotify" event in "data.actionLink" parameter, which contains the information about the action in the document that will be scrolled to.
private String	callbackUrl Specifies absolute URL to the document storage service (which must be implemented by the software integrators who use ONLYOFFICE Document Server on their own server).
private CoEditing	coEditing Defines the co-editing mode ("Fast" or "Strict") and the possibility to change it.
private String	createUrl Defines the absolute URL of the document where it will be created and available after creation.
private Customization	customization 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.
private Embedded	embedded Defines the parameters for the embedded document type only (see the Config section to find out how to define the embedded document type).
private String	lang Defines the editor interface language (if some other languages other than English are present).
private String	location Deprecated.
private Mode	mode Defines the editor opening mode.
private Plugins	plugins Defines the parameters to connect the special add-ons to your Document Server installation which will help you add additional features to document editors.
private List<Recent>	recent Defines the presence or absence of the documents in the "Open Recent..." menu option.
private String	region Defines the default display format for currency and date and time (in the "Spreadsheet Editor" only).
private List<Template>	templates Defines the presence or absence of the templates in the "Create New..." menu option.
private User	user Defines the user currently viewing or editing the document.

Constructor Summary

Constructors

Constructor and Description
EditorConfig()

Method Summary

Methods inherited from class java.lang.Object

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

Field Detail

actionLink

private Object actionLink

Specifies the data received from the document editing service using the "onMakeActionLink" event or the "onRequestSendNotify" event in "data.actionLink" parameter, which contains the information about the action in the document that will be scrolled to.

See Also:

onMakeActionLink event in API ONLYOFFICE, onRequestSendNotify event in API ONLYOFFICE

callbackUrl

private String callbackUrl

Specifies absolute URL to the document storage service (which must be implemented by the software integrators who use ONLYOFFICE Document Server on their own server).

coEditing

private CoEditing coEditing

Defines the co-editing mode ("Fast" or "Strict") and the possibility to change it. This parameter is used to apply the co-editing and viewing modes.

createUrl

private String createUrl

Defines the absolute URL of the document where it will be created and available after creation. If not specified, there will be no creation button. Instead of this field, you can use the "onRequestCreateNew" event.

See Also:

"onRequestCreateNew" event in API ONLYOFFICE

lang

private String lang

Defines the editor interface language (if some other languages other than English are present). Is set using the two letter (de, ru, it, etc.) language codes. The default value is "en".

location

@Deprecated
private String location

Deprecated.

Defines the default measurement units. Specify "us" or "ca" to set inches. The default value is "". Deprecated since version 8.2, please use the region parameter instead.

mode

private Mode mode

Defines the editor opening mode. Can be either "view" to open the document for viewing, or "edit" to open the document in the editing mode allowing to apply changes to the document data. The default value is "edit".

recent

private List<Recent> recent

Defines the presence or absence of the documents in the "Open Recent..." menu option.

region

private String region

Defines the default display format for currency and date and time (in the "Spreadsheet Editor" only). Is set using the four letter (en-US, fr-FR, etc.) language codes. For the default value the "lang" parameter is taken, or, if no regional setting corresponding to the "lang" value is available, "en-US" is used.

templates

private List<Template> templates

Defines the presence or absence of the templates in the "Create New..." menu option.

user

private User user

Defines the user currently viewing or editing the document.

customization

private Customization customization

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.

embedded

private Embedded embedded

Defines the parameters for the embedded document type only (see the Config section to find out how to define the embedded document type). It allows to change the settings which define the behavior of the buttons in the embedded mode.

plugins

private Plugins plugins

Defines the parameters to connect the special add-ons to your Document Server installation which will help you add additional features to document editors.

Constructor Detail

EditorConfig

public EditorConfig()