Oxygen XML Editor 15.0 Author API

ro.sync.exml.editor
Interface EditorTemplate


@API(type=NOT_EXTENDABLE,
     src=PUBLIC)
public interface EditorTemplate

Used to create a new editor for a given extension. It also has a description


Field Summary
static int ARCHIVE_TEMPLATE
          The archive template type.
static int EDITOR_TEMPLATE
          The new editor template type.
static int FILE_TEMPLATE
          The classic type of template represented by a file on HDD.
 
Method Summary
 java.lang.Object clone()
          Clone this editor template.
 java.lang.String getAdditionalInformation()
          Return additional information about this template (e.g.
 int getCaretPosition()
           
 java.lang.String getCustomizePageID()
          Get the ID representing the page used for customizing the template.
 java.lang.String getDescription()
          Return the template description.
 java.lang.String getExtension()
          Return the template extension.
 java.lang.String getLongDescription()
          Return the template's description which will be shown as a tooltip.
 java.lang.String getName()
          Return the template name.
 java.lang.String getSource()
           
 int getTemplateType()
           
 boolean isCustomizable()
           
 

Field Detail

EDITOR_TEMPLATE

static final int EDITOR_TEMPLATE
The new editor template type.

See Also:
Constant Field Values

FILE_TEMPLATE

static final int FILE_TEMPLATE
The classic type of template represented by a file on HDD.

See Also:
Constant Field Values

ARCHIVE_TEMPLATE

static final int ARCHIVE_TEMPLATE
The archive template type.

See Also:
Constant Field Values
Method Detail

getDescription

java.lang.String getDescription()
Return the template description.

Returns:
The template description.

getExtension

java.lang.String getExtension()
Return the template extension.

Returns:
The template extension.

getSource

java.lang.String getSource()
Returns:
A description from where this template was loaded.

getTemplateType

int getTemplateType()
Returns:
The template type. Currently one of: EDITOR_TEMPLATE, FILE_TEMPLATE or ARCHIVE_TEMPLATE.

clone

java.lang.Object clone()
Clone this editor template.

Returns:
The clone or null if unsuccessful.

getName

java.lang.String getName()
Return the template name.

Returns:
The template name.

getAdditionalInformation

java.lang.String getAdditionalInformation()
Return additional information about this template (e.g. Framework, Path etc).

Returns:
Additional information.

isCustomizable

boolean isCustomizable()
Returns:
true if the template can be customized.

getCustomizePageID

java.lang.String getCustomizePageID()
Get the ID representing the page used for customizing the template.

Returns:
The ID representing the page used for customizing the template.

getCaretPosition

int getCaretPosition()
Returns:
The caret position to be set after loading the template.

getLongDescription

java.lang.String getLongDescription()
Return the template's description which will be shown as a tooltip.

Returns:
The template long description.

Oxygen XML Editor 15.0 Author API

© Copyright SyncRO Soft SRL 2002 - 2013. All rights reserved.