Package com.intellij.openapi.fileEditor

Interface TransferableFileEditorState

All Superinterfaces:

FileEditorState

All Known Implementing Classes:

ImageFileEditorState

public interface TransferableFileEditorState
extends FileEditorState

This interface extends FileEditorState interface to sync some editor's options Example: we have image editor and open image files, image by image. We'd like to set default zoom factor to 1:1, but this is not the default value for this option. So, we can use methods in this interface to store these options somewhere and apply them within the session (the time we need these options).

Field Summary

Fields inherited from interface com.intellij.openapi.fileEditor.FileEditorState

INSTANCE

Method Summary

Modifier and Type	Method and Description
java.lang.String	getEditorId() Returns unique editor ID
java.util.Map<java.lang.String,java.lang.String>	getTransferableOptions() Options name-value string mapping.
void	setCopiedFromMasterEditor()
void	setTransferableOptions(java.util.Map<java.lang.String,java.lang.String> options) Applies options to the editor

Methods inherited from interface com.intellij.openapi.fileEditor.FileEditorState

canBeMergedWith

Method Detail

getEditorId

java.lang.String getEditorId()

Returns unique editor ID

Returns:

unique editor ID

getTransferableOptions

java.util.Map<java.lang.String,java.lang.String> getTransferableOptions()

Options name-value string mapping. Example: {{"zoomFactor": "1:1"}, {"transparentBackground": "false"}}

Returns:

name-value string mapping

setTransferableOptions

void setTransferableOptions(java.util.Map<java.lang.String,java.lang.String> options)

Applies options to the editor

Parameters:

options - name-value string mapping

setCopiedFromMasterEditor

void setCopiedFromMasterEditor()