com.ontimize.gui.field
Class HTMLDataField

java.lang.Object
  java.awt.Component
      java.awt.Container
          javax.swing.JComponent
              javax.swing.JPanel
                  com.ontimize.gui.field.DataField
                      com.ontimize.gui.field.MemoDataField
                          com.ontimize.gui.field.HTMLDataField

All Implemented Interfaces:

AccessForm, javax.accessibility.Accessible, AdvancedDataComponent, ApplicationPreferencesListener, DataComponent, java.util.EventListener, FormComponent, Freeable, HasHelpIdComponent, HasPreferenceComponent, IdentifiedElement, java.awt.image.ImageObserver, Internationalization, ITemplateField, java.awt.MenuContainer, OpenDialog, SecureElement, java.io.Serializable, ValueChangeDataComponent

public class HTMLDataField

extends MemoDataField

implements AdvancedDataComponent, ITemplateField

Main class to implement a specific HTML data field.

Author:

Imatia Innovation

See Also:

Serialized Form

Nested Class Summary

protected class	HTMLDataField.ActionWrapper Class to adapt the style field.
protected class	HTMLDataField.AlignListener
static class	HTMLDataField.ExtForegroundAction Main class to manage correctly the field color.
protected static class	HTMLDataField.ToggleButton

Nested classes inherited from class com.ontimize.gui.field.MemoDataField

MemoDataField.InnerDocumentListener

Nested classes inherited from class com.ontimize.gui.field.DataField

DataField.AuxPanel, DataField.CopyActionListener, DataField.ELabel, DataField.FieldButton, DataField.FieldFocusListener, DataField.InfoMouseListener

Nested classes inherited from class javax.swing.JPanel

javax.swing.JPanel.AccessibleJPanel

Nested classes inherited from class javax.swing.JComponent

javax.swing.JComponent.AccessibleJComponent

Nested classes inherited from class java.awt.Container

java.awt.Container.AccessibleAWTContainer

Nested classes inherited from class java.awt.Component

java.awt.Component.AccessibleAWTComponent, java.awt.Component.BltBufferStrategy, java.awt.Component.FlipBufferStrategy

Field Summary

protected boolean	advancedQueryMode
protected javax.swing.ButtonGroup	alignButtonGroup
protected HTMLDataField.AlignListener	alignListener
protected static java.lang.String	BOLD
protected javax.swing.JToggleButton	boldBt
protected boolean	borderbuttons
protected javax.swing.JPanel	buttonsPanel
protected javax.swing.JToggleButton	centerAlignBt
protected javax.swing.JButton	colorButton
protected javax.swing.text.StyleContext	context
protected javax.swing.text.html.HTMLEditorKit	editor Overwrite to avoid break line in the Writer
protected int	fontSizeStep
protected static java.lang.String	HTML_BASE
protected static java.lang.String	ITALIC
protected javax.swing.JToggleButton	italicBt
protected int	lastSelectedFontSize
protected javax.swing.JToggleButton	leftAlignBt
protected java.awt.event.MouseListener	listenerHighlightButtons
protected int	maxFontSize
protected int	minFontSize
protected boolean	opaquebuttons
protected java.lang.String	plainTextColumn
protected javax.swing.JToggleButton	rightAlignBt
protected java.util.Hashtable	styles
protected static java.lang.String	TAB
static boolean	toolBarFiller Variable used to expand the toolbar or not.
protected static java.lang.String	UNDERLINE
protected javax.swing.JToggleButton	underlineBt

Fields inherited from class com.ontimize.gui.field.MemoDataField

activationScrollTip, DE, dQuery, expandVertical, innerListener, maximumTextLength, parentFrame, queryKey, rows, scroll, scrollTip, searchMenu, selectAllKey, selectAllMenu, sqlTypeText, tabTransferFocus, translateDE, undoManager, uppercase, WHITE_SPACE

Fields inherited from class com.ontimize.gui.field.DataField

ALIGN, ALIGN_CENTER, ALIGN_LEFT, ALIGN_RIGHT, alignment, ASTERISK_REQUIRED_STYLE, ATTR, attribute, backgroundColor, BGCOLOR, bold, BORDER, BORDER_REQUIRED_STYLE, borderText, BOTTOM, CENTER, CLIPBOARD_COPY, CLIPBOARD_COPY_es_ES, CLIPBOARD_CUT, CLIPBOARD_CUT_es_ES, CLIPBOARD_PASTE, CLIPBOARD_PASTE_es_ES, conditions, dataField, DEFAULT_BORDER, DEFAULT_BOTTOM_MARGIN, DEFAULT_FIELD_LEFT_MARGIN, DEFAULT_FIELD_RIGHT_MARGIN, DEFAULT_LABEL_LEFT_MARGIN, DEFAULT_LABEL_RIGHT_MARGIN, DEFAULT_PARENT_MARGIN, DEFAULT_PARENT_MARGIN_FOR_SCROLL, DEFAULT_TOP_MARGIN, defaultAsteriskColor, DEFAULTBORDER, defaultDisableBackgroundColor, defaultFieldButtonHigh, defaultPreferenceTextNotRetrievedFromPreferences, DEFINE_HELP_FIELD_PREFERENCE, dim, DIM, disabledbgcolor, DISABLEDBGCOLOR, empty, enabled, ENABLED, FIELD_HELP_TIP, fieldlistenerFocus, fieldSize, fireValueEvents, FOCUS_BACKGROUNDCOLOR, FONT, fontColor, FONTCOLOR, fontSize, FONTSIZE, height, HEIGHT, incrementalFont, initPreferenceHelpText, isEnabled, LABELALIGN, labelComponent, LABELFONT, LABELFONTCOLOR, labelPosition, LABELPOSITION, LABELSIZE, labelText, LABELVISIBLE, LEFT, locale, LOWERED, menuCopy, menuCut, menuDefineHelpPreference, menuHelpPreferences, menuPaste, modifiable, NO_STR, NONE, noRequiredBorder, OPAQUE, originalSize, OUTBORDER, panel, parentForm, permissionActivate, permissionVisible, popupMenu, RAISED, redimensionPanel, redimensJTextField, required, REQUIRED, requiredBorder, REQUIREDBORDER, requiredFieldBackgroundColor, resources, restricted, RIGHT, show, showLabel, SIZE, TEXT_STR, TEXTALIGN, textAlignment, textHelpPreference, TIP, tipKey, TOP, validData, VALIGN, Valignment, valueListener, valueSave, VISIBLE, VISUALIZE_HELP_FIELD_PREFERENCE, weightDataFieldH, weightPanelH, width, WIDTH, x, X, y, Y, YES_STR

Fields inherited from class javax.swing.JComponent

accessibleContext, listenerList, TOOL_TIP_TEXT_KEY, ui, UNDEFINED_CONDITION, WHEN_ANCESTOR_OF_FOCUSED_COMPONENT, WHEN_FOCUSED, WHEN_IN_FOCUSED_WINDOW

Fields inherited from class java.awt.Component

BOTTOM_ALIGNMENT, CENTER_ALIGNMENT, LEFT_ALIGNMENT, RIGHT_ALIGNMENT, TOP_ALIGNMENT

Fields inherited from interface com.ontimize.gui.field.AdvancedDataComponent

ADVANCED_QUERY

Fields inherited from interface com.ontimize.gui.field.DataComponent

COMP_FOCUS_YELLOW, GREEN_VERY_LIGHT, LIGHT_GRAY_BLUE, LIGHT_GREYISH_BLUE, VERY_LIGHT_BLUE, VERY_LIGHT_GRAY, VERY_LIGHT_PINK, VERY_LIGHT_RED, VERY_LIGHT_SKYBLUE, VERY_LIGHT_YELLOW, VERY_LIGHT_YELLOW_2

Fields inherited from interface com.ontimize.gui.field.FormComponent

DEBUG

Fields inherited from interface com.ontimize.gui.i18n.Internationalization

DEBUG_LANGUAGE

Fields inherited from interface com.ontimize.gui.SecureElement

DESACTIVATE_COMPONENT_BY_PERMISSION_TIP

Fields inherited from interface com.ontimize.util.templates.ITemplateField

DATA_TYPE_FIELD, DATA_TYPE_FIELD_ATTR, DATA_TYPE_IMAGE, DATA_TYPE_IMAGE_ATTR, DATA_TYPE_TABLE, DATA_TYPE_TABLE_ATTR, TEMPLATE_DATA_TYPE

Fields inherited from interface java.awt.image.ImageObserver

ABORT, ALLBITS, ERROR, FRAMEBITS, PROPERTIES, SOMEBITS

Constructor Summary

HTMLDataField(java.util.Hashtable parameters)
Initializes parameters.

Method Summary

protected void	configureButtonsPanelAndEditor()
protected void	createDataField() Creates the field and overrides the JComponent.processKeyEvent(KeyEvent) method for managing focus.
protected void	createFontSizeCombo() Creates a combo with height fonts minFontSize to maxFontSize.
protected void	createStyles() Creates styles(underlined, bold, ...)
void	deleteData() The method to delete data for component.
java.lang.String	getName()
protected java.awt.Font	getSelectedTextFont(int offset, int length)
int	getTemplateDataType() Returns the data type.
java.lang.Object	getTemplateDataValue() Gets an image with content of rendered field.
java.lang.Object	getValue() Gets the value of a component.
void	init(java.util.Hashtable params) Main method to init an object from parameters hashtable.
protected void	installButtonsHandler() Installs the button handler to manage buttons for document.
protected void	installSelectionTextListener()
boolean	isEmpty() Checks the data existence in component.
void	setAdvancedQueryMode(boolean mode) This method must establish the advanced query state, to support advanced query conditions.
void	setButtonPanelVisible(boolean v) Sets visible the buttons panel.
protected void	setCharacterAttributes(javax.swing.text.AttributeSet attr, boolean replace) Changes the character attributes.
void	setEnabled(boolean en) Description method to set enabled or not the component according the boolean condition in parameter.
protected void	setParagraphAttributes(int offset, int length, javax.swing.text.AttributeSet at, boolean replace) Sets paragraph attributes.
protected void	setTextAttributes(int offset, int length, javax.swing.text.AttributeSet at, boolean replace) Sets text attributes.
protected void	setTextFontColor(int offset, int length, java.awt.Color c)
protected void	setTextFontSize(int offset, int length, int size)
void	setValue(java.lang.Object value) Sets the value for component.

Methods inherited from class com.ontimize.gui.field.MemoDataField

createPopupMenu, enableInnerListener, free, getConstraints, getRowNumber, getSQLDataType, getText, getTextsToTranslate, hideScrollTip, installInnerListener, installScrollListener, registerUndoableListener, registerUndoRedoActions, setComponentLocale, setMaxLength, setParentFrame, setResourceBundle, showPopupMenu, showScrollTip, updateBackgroundColor

Methods inherited from class com.ontimize.gui.field.DataField

addFocusListener, addHelpMenuPopup, addValueChangeListener, changeButton, changeOpacity, checkDefineHelpPermission, checkEnabledPermission, checkVisiblePermission, configurePopupMenuHelp, createFocusListener, createInstanceConditionCombo, defineHelpField, finalize, fireValueChanged, getAttribute, getBorder, getDataField, getDisabledbgcolor, getFontColor, getHelpIdString, getHelpPreferenceKey, getLabelComponent, getLabelComponentText, getLabelFontColor, getLabelText, getParentForm, getPreferenceHelpText, getValueChangeListeners, hasHelpInPreferences, initPermissions, initPreferences, installFocusListener, installHelpId, installPopupMenuListener, installPreferenceHelpListener, isAdvancedQueryMode, isEnabled, isHidden, isLabelVisible, isModifiable, isModified, isRequired, isRestricted, parseBoolean, preferenceChanged, removeFocusListener, removeValueChangeListener, requestFocus, seeHelpField, setBold, setDisabledbgcolor, setFont, setFontColor, setFontSize, setLabelFontColor, setModifiable, setParentForm, setRequired, setRequiredFieldBackground, setVisible, updateBackgroundColor, updateFont, updateTip, updateUI, validateComponentPositions

Methods inherited from class javax.swing.JPanel

getAccessibleContext, getUI, getUIClassID, paramString, setUI

Methods inherited from class javax.swing.JComponent

addAncestorListener, addNotify, addPropertyChangeListener, addPropertyChangeListener, addVetoableChangeListener, computeVisibleRect, contains, createToolTip, disable, enable, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, fireVetoableChange, getActionForKeyStroke, getActionMap, getAlignmentX, getAlignmentY, getAncestorListeners, getAutoscrolls, getBorder, getBounds, getClientProperty, getComponentGraphics, getConditionForKeyStroke, getDebugGraphicsOptions, getDefaultLocale, getGraphics, getHeight, getInputMap, getInputMap, getInputVerifier, getInsets, getInsets, getListeners, getLocation, getMaximumSize, getMinimumSize, getNextFocusableComponent, getPreferredSize, getPropertyChangeListeners, getPropertyChangeListeners, getRegisteredKeyStrokes, getRootPane, getSize, getToolTipLocation, getToolTipText, getToolTipText, getTopLevelAncestor, getTransferHandler, getVerifyInputWhenFocusTarget, getVetoableChangeListeners, getVisibleRect, getWidth, getX, getY, grabFocus, isDoubleBuffered, isLightweightComponent, isManagingFocus, isMaximumSizeSet, isMinimumSizeSet, isOpaque, isOptimizedDrawingEnabled, isPaintingTile, isPreferredSizeSet, isRequestFocusEnabled, isValidateRoot, paint, paintBorder, paintChildren, paintComponent, paintImmediately, paintImmediately, print, printAll, printBorder, printChildren, printComponent, processComponentKeyEvent, processKeyBinding, processKeyEvent, processMouseMotionEvent, putClientProperty, registerKeyboardAction, registerKeyboardAction, removeAncestorListener, removeNotify, removePropertyChangeListener, removePropertyChangeListener, removeVetoableChangeListener, repaint, repaint, requestDefaultFocus, requestFocus, requestFocusInWindow, requestFocusInWindow, resetKeyboardActions, reshape, revalidate, scrollRectToVisible, setActionMap, setAlignmentX, setAlignmentY, setAutoscrolls, setBackground, setBorder, setDebugGraphicsOptions, setDefaultLocale, setDoubleBuffered, setForeground, setInputMap, setInputVerifier, setMaximumSize, setMinimumSize, setNextFocusableComponent, setOpaque, setPreferredSize, setRequestFocusEnabled, setToolTipText, setTransferHandler, setUI, setVerifyInputWhenFocusTarget, unregisterKeyboardAction, update

Methods inherited from class java.awt.Container

add, add, add, add, add, addContainerListener, addImpl, applyComponentOrientation, areFocusTraversalKeysSet, countComponents, deliverEvent, doLayout, findComponentAt, findComponentAt, getComponent, getComponentAt, getComponentAt, getComponentCount, getComponents, getContainerListeners, getFocusTraversalKeys, getFocusTraversalPolicy, getLayout, insets, invalidate, isAncestorOf, isFocusCycleRoot, isFocusCycleRoot, isFocusTraversalPolicySet, layout, list, list, locate, minimumSize, paintComponents, preferredSize, printComponents, processContainerEvent, processEvent, remove, remove, removeAll, removeContainerListener, setFocusCycleRoot, setFocusTraversalKeys, setFocusTraversalPolicy, setLayout, transferFocusBackward, transferFocusDownCycle, validate, validateTree

Methods inherited from class java.awt.Component

action, add, addComponentListener, addHierarchyBoundsListener, addHierarchyListener, addInputMethodListener, addKeyListener, addMouseListener, addMouseMotionListener, addMouseWheelListener, bounds, checkImage, checkImage, coalesceEvents, contains, createImage, createImage, createVolatileImage, createVolatileImage, disableEvents, dispatchEvent, enable, enableEvents, enableInputMethods, getBackground, getBounds, getColorModel, getComponentListeners, getComponentOrientation, getCursor, getDropTarget, getFocusCycleRootAncestor, getFocusListeners, getFocusTraversalKeysEnabled, getFont, getFontMetrics, getForeground, getGraphicsConfiguration, getHierarchyBoundsListeners, getHierarchyListeners, getIgnoreRepaint, getInputContext, getInputMethodListeners, getInputMethodRequests, getKeyListeners, getLocale, getLocation, getLocationOnScreen, getMouseListeners, getMouseMotionListeners, getMouseWheelListeners, getParent, getPeer, getSize, getToolkit, getTreeLock, gotFocus, handleEvent, hasFocus, hide, imageUpdate, inside, isBackgroundSet, isCursorSet, isDisplayable, isFocusable, isFocusOwner, isFocusTraversable, isFontSet, isForegroundSet, isLightweight, isShowing, isValid, isVisible, keyDown, keyUp, list, list, list, location, lostFocus, mouseDown, mouseDrag, mouseEnter, mouseExit, mouseMove, mouseUp, move, nextFocus, paintAll, postEvent, prepareImage, prepareImage, processComponentEvent, processFocusEvent, processHierarchyBoundsEvent, processHierarchyEvent, processInputMethodEvent, processMouseEvent, processMouseWheelEvent, remove, removeComponentListener, removeHierarchyBoundsListener, removeHierarchyListener, removeInputMethodListener, removeKeyListener, removeMouseListener, removeMouseMotionListener, removeMouseWheelListener, repaint, repaint, repaint, resize, resize, setBounds, setBounds, setComponentOrientation, setCursor, setDropTarget, setFocusable, setFocusTraversalKeysEnabled, setIgnoreRepaint, setLocale, setLocation, setLocation, setName, setSize, setSize, show, show, size, toString, transferFocus, transferFocusUpCycle

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.ontimize.gui.field.DataComponent

getLabelComponentText, getSQLDataType, isHidden, isModifiable, isModified, isRequired, setModifiable, setRequired

Methods inherited from interface com.ontimize.gui.field.FormComponent

getConstraints, isEnabled, setVisible

Methods inherited from interface com.ontimize.gui.i18n.Internationalization

getTextsToTranslate, setComponentLocale, setResourceBundle

Methods inherited from interface com.ontimize.gui.field.IdentifiedElement

getAttribute

Methods inherited from interface com.ontimize.gui.SecureElement

initPermissions, isRestricted

Field Detail

toolBarFiller

public static boolean toolBarFiller

Variable used to expand the toolbar or not. It it is false, it means that toolbar is full expanded. By default it is false.

BOLD

protected static final java.lang.String BOLD

See Also:

Constant Field Values

ITALIC

protected static final java.lang.String ITALIC

See Also:

Constant Field Values

UNDERLINE

protected static final java.lang.String UNDERLINE

See Also:

Constant Field Values

HTML_BASE

protected static final java.lang.String HTML_BASE

See Also:

Constant Field Values

TAB

protected static final java.lang.String TAB

See Also:

Constant Field Values

minFontSize

protected int minFontSize

maxFontSize

protected int maxFontSize

fontSizeStep

protected int fontSizeStep

opaquebuttons

protected boolean opaquebuttons

borderbuttons

protected boolean borderbuttons

listenerHighlightButtons

protected java.awt.event.MouseListener listenerHighlightButtons

lastSelectedFontSize

protected int lastSelectedFontSize

buttonsPanel

protected javax.swing.JPanel buttonsPanel

boldBt

protected javax.swing.JToggleButton boldBt

italicBt

protected javax.swing.JToggleButton italicBt

underlineBt

protected javax.swing.JToggleButton underlineBt

leftAlignBt

protected javax.swing.JToggleButton leftAlignBt

centerAlignBt

protected javax.swing.JToggleButton centerAlignBt

rightAlignBt

protected javax.swing.JToggleButton rightAlignBt

colorButton

protected javax.swing.JButton colorButton

context

protected javax.swing.text.StyleContext context

styles

protected java.util.Hashtable styles

editor

protected javax.swing.text.html.HTMLEditorKit editor

Overwrite to avoid break line in the Writer

plainTextColumn

protected java.lang.String plainTextColumn

advancedQueryMode

protected boolean advancedQueryMode

alignListener

protected HTMLDataField.AlignListener alignListener

alignButtonGroup

protected javax.swing.ButtonGroup alignButtonGroup

Constructor Detail

HTMLDataField

public HTMLDataField(java.util.Hashtable parameters)

Initializes parameters. Configure buttons and adds key events. XML definition could be contains an optional parameter: 'plaintextcolumn' specifying the identifier to save the text in plain format.

Parameters:

parameters - the Hashtable with parameters

Method Detail

init

public void init(java.util.Hashtable params)

Description copied from interface: FormComponent

Main method to init an object from parameters hashtable.

Specified by:

init in interface FormComponent

Overrides:

init in class MemoDataField

Parameters:

params - the hashtable with parameters

attribute	values	default	required	meaning
sqltexttype	yes/no	no	no	no -> Varchar ; yes -> LongVarchar.
uppercase	yes/no	no	no	The uppercase condition.
rows			no	The number of rows.
maxlength			no	The maxlength for component.
expand	yes/no		no	The vertical expansion.

createFontSizeCombo

protected void createFontSizeCombo()

Creates a combo with height fonts minFontSize to maxFontSize.

installButtonsHandler

protected void installButtonsHandler()

Installs the button handler to manage buttons for document.

setEnabled

public void setEnabled(boolean en)

Description copied from interface: FormComponent

Description method to set enabled or not the component according the boolean condition in parameter.

Specified by:

setEnabled in interface FormComponent

Overrides:

setEnabled in class DataField

Parameters:

en - the condition to set enable

configureButtonsPanelAndEditor

protected void configureButtonsPanelAndEditor()

getSelectedTextFont

protected java.awt.Font getSelectedTextFont(int offset,
                                            int length)

installSelectionTextListener

protected void installSelectionTextListener()

setValue

public void setValue(java.lang.Object value)

Description copied from interface: DataComponent

Sets the value for component.

Specified by:

setValue in interface DataComponent

Overrides:

setValue in class MemoDataField

deleteData

public void deleteData()

Description copied from interface: DataComponent

The method to delete data for component.

Specified by:

deleteData in interface DataComponent

Overrides:

deleteData in class MemoDataField

getValue

public java.lang.Object getValue()

Description copied from interface: DataComponent

Gets the value of a component.

Specified by:

getValue in interface DataComponent

Overrides:

getValue in class MemoDataField

createStyles

protected void createStyles()

Creates styles(underlined, bold, ...)

createDataField

protected void createDataField()

Description copied from class: MemoDataField

Creates the field and overrides the JComponent.processKeyEvent(KeyEvent) method for managing focus.

Overrides:

createDataField in class MemoDataField

getName

public java.lang.String getName()

setTextAttributes

protected void setTextAttributes(int offset,
                                 int length,
                                 javax.swing.text.AttributeSet at,
                                 boolean replace)

Sets text attributes.

Parameters:

offset - the start of changes

length - the lenght of changes

at - the attribute set

replace - the condition replacement

setCharacterAttributes

protected void setCharacterAttributes(javax.swing.text.AttributeSet attr,
                                      boolean replace)

Changes the character attributes.

Parameters:

attr - the attribute set

replace - the condition of replacement

setParagraphAttributes

protected void setParagraphAttributes(int offset,
                                      int length,
                                      javax.swing.text.AttributeSet at,
                                      boolean replace)

Sets paragraph attributes.

Parameters:

offset - the start of change

length - the length of change

at - the attribute set

replace - the condition of replacement

setTextFontSize

protected void setTextFontSize(int offset,
                               int length,
                               int size)

setTextFontColor

protected void setTextFontColor(int offset,
                                int length,
                                java.awt.Color c)

isEmpty

public boolean isEmpty()

Description copied from interface: DataComponent

Checks the data existence in component.

Specified by:

isEmpty in interface DataComponent

Overrides:

isEmpty in class MemoDataField

setButtonPanelVisible

public void setButtonPanelVisible(boolean v)

Sets visible the buttons panel.

Parameters:

v - the condition about visibility panel

setAdvancedQueryMode

public void setAdvancedQueryMode(boolean mode)

Description copied from interface: AdvancedDataComponent

This method must establish the advanced query state, to support advanced query conditions.

Specified by:

setAdvancedQueryMode in interface AdvancedDataComponent

Parameters:

mode - the condition to enable this state

getTemplateDataType

public int getTemplateDataType()

Description copied from interface: ITemplateField

Returns the data type. The values that can return are: ITemplateField.DATA_TYPE_FIELD ITemplateField.DATA_TYPE_IMAGE ITemplateField.DATA_TYPE_TABLE

Specified by:

getTemplateDataType in interface ITemplateField

Returns:

a int with the data type.

getTemplateDataValue

public java.lang.Object getTemplateDataValue()

Gets an image with content of rendered field.

Specified by:

getTemplateDataValue in interface ITemplateField

Returns:

Since:

5.2067EN