Package com._1c.g5.v8.dt.form.model

Interface FormField

All Superinterfaces:

ContextMenuHolder, DataItem, org.eclipse.emf.ecore.EObject, EventHandlerContainer, ExtendedTooltipHolder, ExtensionAdoptedProperty, FormItem, FormStandardCommandSource, FormVisualEntity, IBmObject, NamedElement, org.eclipse.emf.common.notify.Notifier, Titled, TitleStyle, TooltipContainer, Visible

All Known Implementing Classes:

FormFieldImpl

public interface FormField
extends DataItem, FormStandardCommandSource, TitleStyle, TooltipContainer, EventHandlerContainer, ExtendedTooltipHolder, ContextMenuHolder, ExtensionAdoptedProperty

A representation of the model object 'Field'.

The following features are supported:

• Type
• Read Only
• Warning On Edit Representation
• Warning On Edit
• Horizontal Align
• Vertical Align
• Group Horizontal Align
• Group Vertical Align
• Edit Mode
• Fixing In Table
• Cell Hyperlink
• Auto Cell Height
• Show In Header
• Header Picture
• Header Horizontal Align
• Show In Footer
• Footer Data Path
• Footer Text
• Footer Text Color
• Footer Back Color
• Footer Font
• Footer Picture
• Footer Horizontal Align
• On Main Server Unavalable Behavior
• Ext Info

See Also:

FormPackage.getFormField()

Method Summary

Modifier and Type	Method	Description
TableFieldEditMode	getEditMode()	Returns the value of the 'Edit Mode' attribute.
FieldExtInfo	getExtInfo()	Returns the value of the 'Ext Info' containment reference.
FormFixedInTable	getFixingInTable()	Returns the value of the 'Fixing In Table' attribute.
Color	getFooterBackColor()	Returns the value of the 'Footer Back Color' containment reference.
AbstractDataPath	getFooterDataPath()	Returns the value of the 'Footer Data Path' containment reference.
Font	getFooterFont()	Returns the value of the 'Footer Font' containment reference.
ItemHorizontalAlignment	getFooterHorizontalAlign()	Returns the value of the 'Footer Horizontal Align' attribute.
Picture	getFooterPicture()	Returns the value of the 'Footer Picture' containment reference.
org.eclipse.emf.common.util.EMap<String,String>	getFooterText()	Returns the value of the 'Footer Text' map.
Color	getFooterTextColor()	Returns the value of the 'Footer Text Color' containment reference.
ItemHorizontalAlignment	getGroupHorizontalAlign()	Returns the value of the 'Group Horizontal Align' attribute.
ItemVerticalAlignment	getGroupVerticalAlign()	Returns the value of the 'Group Vertical Align' attribute.
ItemHorizontalAlignment	getHeaderHorizontalAlign()	Returns the value of the 'Header Horizontal Align' attribute.
Picture	getHeaderPicture()	Returns the value of the 'Header Picture' containment reference.
ItemHorizontalAlignment	getHorizontalAlign()	Returns the value of the 'Horizontal Align' attribute.
OnMainServerUnavalableBehavior	getOnMainServerUnavalableBehavior()	Returns the value of the 'On Main Server Unavalable Behavior' attribute.
ManagedFormFieldType	getType()	Returns the value of the 'Type' attribute.
ItemVerticalAlignment	getVerticalAlign()	Returns the value of the 'Vertical Align' attribute.
org.eclipse.emf.common.util.EMap<String,String>	getWarningOnEdit()	Returns the value of the 'Warning On Edit' map.
WarningOnEditRepresentation	getWarningOnEditRepresentation()	Returns the value of the 'Warning On Edit Representation' attribute.
boolean	isAutoCellHeight()	Returns the value of the 'Auto Cell Height' attribute.
boolean	isCellHyperlink()	Returns the value of the 'Cell Hyperlink' attribute.
boolean	isReadOnly()	Returns the value of the 'Read Only' attribute.
boolean	isShowInFooter()	Returns the value of the 'Show In Footer' attribute.
boolean	isShowInHeader()	Returns the value of the 'Show In Header' attribute.
void	setAutoCellHeight(boolean value)	Sets the value of the 'Auto Cell Height' attribute.
void	setCellHyperlink(boolean value)	Sets the value of the 'Cell Hyperlink' attribute.
void	setEditMode(TableFieldEditMode value)	Sets the value of the 'Edit Mode' attribute.
void	setExtInfo(FieldExtInfo value)	Sets the value of the 'Ext Info' containment reference.
void	setFixingInTable(FormFixedInTable value)	Sets the value of the 'Fixing In Table' attribute.
void	setFooterBackColor(Color value)	Sets the value of the 'Footer Back Color' containment reference.
void	setFooterDataPath(AbstractDataPath value)	Sets the value of the 'Footer Data Path' containment reference.
void	setFooterFont(Font value)	Sets the value of the 'Footer Font' containment reference.
void	setFooterHorizontalAlign(ItemHorizontalAlignment value)	Sets the value of the 'Footer Horizontal Align' attribute.
void	setFooterPicture(Picture value)	Sets the value of the 'Footer Picture' containment reference.
void	setFooterTextColor(Color value)	Sets the value of the 'Footer Text Color' containment reference.
void	setGroupHorizontalAlign(ItemHorizontalAlignment value)	Sets the value of the 'Group Horizontal Align' attribute.
void	setGroupVerticalAlign(ItemVerticalAlignment value)	Sets the value of the 'Group Vertical Align' attribute.
void	setHeaderHorizontalAlign(ItemHorizontalAlignment value)	Sets the value of the 'Header Horizontal Align' attribute.
void	setHeaderPicture(Picture value)	Sets the value of the 'Header Picture' containment reference.
void	setHorizontalAlign(ItemHorizontalAlignment value)	Sets the value of the 'Horizontal Align' attribute.
void	setOnMainServerUnavalableBehavior(OnMainServerUnavalableBehavior value)	Sets the value of the 'On Main Server Unavalable Behavior' attribute.
void	setReadOnly(boolean value)	Sets the value of the 'Read Only' attribute.
void	setShowInFooter(boolean value)	Sets the value of the 'Show In Footer' attribute.
void	setShowInHeader(boolean value)	Sets the value of the 'Show In Header' attribute.
void	setType(ManagedFormFieldType value)	Sets the value of the 'Type' attribute.
void	setVerticalAlign(ItemVerticalAlignment value)	Sets the value of the 'Vertical Align' attribute.
void	setWarningOnEditRepresentation(WarningOnEditRepresentation value)	Sets the value of the 'Warning On Edit Representation' attribute.
boolean	validate(org.eclipse.emf.common.util.DiagnosticChain diagnostics, Map<Object,Object> context)

Methods inherited from interface com._1c.g5.v8.dt.form.model.ContextMenuHolder

getContextMenu, setContextMenu

Methods inherited from interface com._1c.g5.v8.dt.form.model.DataItem

getDataPath, getShortcut, getSkipOnInput, getTitleBackColor, getTitleHeight, getTitleLocation, isDefaultItem, setDataPath, setDefaultItem, setShortcut, setSkipOnInput, setTitleBackColor, setTitleHeight, setTitleLocation

Methods inherited from interface org.eclipse.emf.ecore.EObject

eAllContents, eClass, eContainer, eContainingFeature, eContainmentFeature, eContents, eCrossReferences, eGet, eGet, eInvoke, eIsProxy, eIsSet, eResource, eSet, eUnset

Methods inherited from interface com._1c.g5.v8.dt.form.model.EventHandlerContainer

getHandlers

Methods inherited from interface com._1c.g5.v8.dt.form.model.ExtendedTooltipHolder

getExtendedTooltip, setExtendedTooltip

Methods inherited from interface com._1c.g5.v8.dt.form.model.ExtensionAdoptedProperty

getAdopted, getUnchanged, setAdopted, setUnchanged

Methods inherited from interface com._1c.g5.v8.dt.form.model.FormItem

getDisplayImportance, getId, setDisplayImportance, setId

Methods inherited from interface com._1c.g5.v8.dt.form.model.FormStandardCommandSource

getCommands, getExcludedCommands

Methods inherited from interface com._1c.g5.v8.dt.form.model.FormVisualEntity

getUserChangedProperties

Methods inherited from interface com._1c.g5.v8.bm.core.IBmObject

bmGetEngine, bmGetFqn, bmGetId, bmGetProperties, bmGetProperty, bmGetReferences, bmGetResourceId, bmGetTopObject, bmGetTransaction, bmGetUri, bmGetUriAsString, bmIsTop, bmIsTransient, bmListBinaryData, bmReadBinaryData, bmRemoveBinaryData, bmSetProperty, bmWriteBinaryData

Methods inherited from interface com._1c.g5.v8.dt.mcore.NamedElement

getName, setName

Methods inherited from interface org.eclipse.emf.common.notify.Notifier

eAdapters, eDeliver, eNotify, eSetDeliver

Methods inherited from interface com._1c.g5.v8.dt.form.model.Titled

getTitle

Methods inherited from interface com._1c.g5.v8.dt.form.model.TitleStyle

getTitleFont, getTitleTextColor, setTitleFont, setTitleTextColor

Methods inherited from interface com._1c.g5.v8.dt.form.model.TooltipContainer

getToolTip, getToolTipRepresentation, setToolTipRepresentation

Methods inherited from interface com._1c.g5.v8.dt.form.model.Visible

getUserVisible, isEnabled, isVisible, setEnabled, setUserVisible, setVisible

Method Detail

getType

ManagedFormFieldType getType()

Returns the value of the 'Type' attribute. The literals are from the enumeration ManagedFormFieldType.

Returns:

the value of the 'Type' attribute.

See Also:

ManagedFormFieldType, setType(ManagedFormFieldType), FormPackage.getFormField_Type()

setType

void setType(ManagedFormFieldType value)

Sets the value of the 'Type' attribute.

Parameters:

value - the new value of the 'Type' attribute.

See Also:

ManagedFormFieldType, getType()

isReadOnly

boolean isReadOnly()

Returns the value of the 'Read Only' attribute.

Returns:

the value of the 'Read Only' attribute.

See Also:

setReadOnly(boolean), FormPackage.getFormField_ReadOnly()

setReadOnly

void setReadOnly(boolean value)

Sets the value of the 'Read Only' attribute.

Parameters:

value - the new value of the 'Read Only' attribute.

See Also:

isReadOnly()

getWarningOnEditRepresentation

WarningOnEditRepresentation getWarningOnEditRepresentation()

Returns the value of the 'Warning On Edit Representation' attribute. The literals are from the enumeration WarningOnEditRepresentation.

Returns:

the value of the 'Warning On Edit Representation' attribute.

See Also:

WarningOnEditRepresentation, setWarningOnEditRepresentation(WarningOnEditRepresentation), FormPackage.getFormField_WarningOnEditRepresentation()

setWarningOnEditRepresentation

void setWarningOnEditRepresentation(WarningOnEditRepresentation value)

Sets the value of the 'Warning On Edit Representation' attribute.

Parameters:

value - the new value of the 'Warning On Edit Representation' attribute.

See Also:

WarningOnEditRepresentation, getWarningOnEditRepresentation()

getWarningOnEdit

org.eclipse.emf.common.util.EMap<String,String> getWarningOnEdit()

Returns the value of the 'Warning On Edit' map. The key is of type String, and the value is of type String,

Returns:

the value of the 'Warning On Edit' map.

See Also:

FormPackage.getFormField_WarningOnEdit()

getHorizontalAlign

ItemHorizontalAlignment getHorizontalAlign()

Returns the value of the 'Horizontal Align' attribute. The literals are from the enumeration ItemHorizontalAlignment.

Returns:

the value of the 'Horizontal Align' attribute.

See Also:

ItemHorizontalAlignment, setHorizontalAlign(ItemHorizontalAlignment), FormPackage.getFormField_HorizontalAlign()

setHorizontalAlign

void setHorizontalAlign(ItemHorizontalAlignment value)

Sets the value of the 'Horizontal Align' attribute.

Parameters:

value - the new value of the 'Horizontal Align' attribute.

See Also:

ItemHorizontalAlignment, getHorizontalAlign()

getVerticalAlign

ItemVerticalAlignment getVerticalAlign()

Returns the value of the 'Vertical Align' attribute. The literals are from the enumeration ItemVerticalAlignment.

Returns:

the value of the 'Vertical Align' attribute.

See Also:

ItemVerticalAlignment, setVerticalAlign(ItemVerticalAlignment), FormPackage.getFormField_VerticalAlign()

setVerticalAlign

void setVerticalAlign(ItemVerticalAlignment value)

Sets the value of the 'Vertical Align' attribute.

Parameters:

value - the new value of the 'Vertical Align' attribute.

See Also:

ItemVerticalAlignment, getVerticalAlign()

getGroupHorizontalAlign

ItemHorizontalAlignment getGroupHorizontalAlign()

Returns the value of the 'Group Horizontal Align' attribute. The literals are from the enumeration ItemHorizontalAlignment.

Returns:

the value of the 'Group Horizontal Align' attribute.

See Also:

ItemHorizontalAlignment, setGroupHorizontalAlign(ItemHorizontalAlignment), FormPackage.getFormField_GroupHorizontalAlign()

setGroupHorizontalAlign

void setGroupHorizontalAlign(ItemHorizontalAlignment value)

Sets the value of the 'Group Horizontal Align' attribute.

Parameters:

value - the new value of the 'Group Horizontal Align' attribute.

See Also:

ItemHorizontalAlignment, getGroupHorizontalAlign()

getGroupVerticalAlign

ItemVerticalAlignment getGroupVerticalAlign()

Returns the value of the 'Group Vertical Align' attribute. The literals are from the enumeration ItemVerticalAlignment.

Returns:

the value of the 'Group Vertical Align' attribute.

See Also:

ItemVerticalAlignment, setGroupVerticalAlign(ItemVerticalAlignment), FormPackage.getFormField_GroupVerticalAlign()

setGroupVerticalAlign

void setGroupVerticalAlign(ItemVerticalAlignment value)

Sets the value of the 'Group Vertical Align' attribute.

Parameters:

value - the new value of the 'Group Vertical Align' attribute.

See Also:

ItemVerticalAlignment, getGroupVerticalAlign()

getEditMode

TableFieldEditMode getEditMode()

Returns the value of the 'Edit Mode' attribute. The literals are from the enumeration TableFieldEditMode.

Returns:

the value of the 'Edit Mode' attribute.

See Also:

TableFieldEditMode, setEditMode(TableFieldEditMode), FormPackage.getFormField_EditMode()

setEditMode

void setEditMode(TableFieldEditMode value)

Sets the value of the 'Edit Mode' attribute.

Parameters:

value - the new value of the 'Edit Mode' attribute.

See Also:

TableFieldEditMode, getEditMode()

getFixingInTable

FormFixedInTable getFixingInTable()

Returns the value of the 'Fixing In Table' attribute. The literals are from the enumeration FormFixedInTable.

Returns:

the value of the 'Fixing In Table' attribute.

See Also:

FormFixedInTable, setFixingInTable(FormFixedInTable), FormPackage.getFormField_FixingInTable()

setFixingInTable

void setFixingInTable(FormFixedInTable value)

Sets the value of the 'Fixing In Table' attribute.

Parameters:

value - the new value of the 'Fixing In Table' attribute.

See Also:

FormFixedInTable, getFixingInTable()

isCellHyperlink

boolean isCellHyperlink()

Returns the value of the 'Cell Hyperlink' attribute.

Returns:

the value of the 'Cell Hyperlink' attribute.

See Also:

setCellHyperlink(boolean), FormPackage.getFormField_CellHyperlink()

setCellHyperlink

void setCellHyperlink(boolean value)

Sets the value of the 'Cell Hyperlink' attribute.

Parameters:

value - the new value of the 'Cell Hyperlink' attribute.

See Also:

isCellHyperlink()

isAutoCellHeight

boolean isAutoCellHeight()

Returns the value of the 'Auto Cell Height' attribute.

Returns:

the value of the 'Auto Cell Height' attribute.

See Also:

setAutoCellHeight(boolean), FormPackage.getFormField_AutoCellHeight()

setAutoCellHeight

void setAutoCellHeight(boolean value)

Sets the value of the 'Auto Cell Height' attribute.

Parameters:

value - the new value of the 'Auto Cell Height' attribute.

See Also:

isAutoCellHeight()

isShowInHeader

boolean isShowInHeader()

Returns the value of the 'Show In Header' attribute.

Returns:

the value of the 'Show In Header' attribute.

See Also:

setShowInHeader(boolean), FormPackage.getFormField_ShowInHeader()

setShowInHeader

void setShowInHeader(boolean value)

Sets the value of the 'Show In Header' attribute.

Parameters:

value - the new value of the 'Show In Header' attribute.

See Also:

isShowInHeader()

getHeaderPicture

Picture getHeaderPicture()

Returns the value of the 'Header Picture' containment reference.

Returns:

the value of the 'Header Picture' containment reference.

See Also:

setHeaderPicture(Picture), FormPackage.getFormField_HeaderPicture()

setHeaderPicture

void setHeaderPicture(Picture value)

Sets the value of the 'Header Picture' containment reference.

Parameters:

value - the new value of the 'Header Picture' containment reference.

See Also:

getHeaderPicture()

getHeaderHorizontalAlign

ItemHorizontalAlignment getHeaderHorizontalAlign()

Returns the value of the 'Header Horizontal Align' attribute. The literals are from the enumeration ItemHorizontalAlignment.

Returns:

the value of the 'Header Horizontal Align' attribute.

See Also:

ItemHorizontalAlignment, setHeaderHorizontalAlign(ItemHorizontalAlignment), FormPackage.getFormField_HeaderHorizontalAlign()

setHeaderHorizontalAlign

void setHeaderHorizontalAlign(ItemHorizontalAlignment value)

Sets the value of the 'Header Horizontal Align' attribute.

Parameters:

value - the new value of the 'Header Horizontal Align' attribute.

See Also:

ItemHorizontalAlignment, getHeaderHorizontalAlign()

isShowInFooter

boolean isShowInFooter()

Returns the value of the 'Show In Footer' attribute.

Returns:

the value of the 'Show In Footer' attribute.

See Also:

setShowInFooter(boolean), FormPackage.getFormField_ShowInFooter()

setShowInFooter

void setShowInFooter(boolean value)

Sets the value of the 'Show In Footer' attribute.

Parameters:

value - the new value of the 'Show In Footer' attribute.

See Also:

isShowInFooter()

getFooterDataPath

AbstractDataPath getFooterDataPath()

Returns the value of the 'Footer Data Path' containment reference.

Returns:

the value of the 'Footer Data Path' containment reference.

See Also:

setFooterDataPath(AbstractDataPath), FormPackage.getFormField_FooterDataPath()

setFooterDataPath

void setFooterDataPath(AbstractDataPath value)

Sets the value of the 'Footer Data Path' containment reference.

Parameters:

value - the new value of the 'Footer Data Path' containment reference.

See Also:

getFooterDataPath()

getFooterText

org.eclipse.emf.common.util.EMap<String,String> getFooterText()

Returns the value of the 'Footer Text' map. The key is of type String, and the value is of type String,

Returns:

the value of the 'Footer Text' map.

See Also:

FormPackage.getFormField_FooterText()

getFooterTextColor

Color getFooterTextColor()

Returns the value of the 'Footer Text Color' containment reference.

Returns:

the value of the 'Footer Text Color' containment reference.

See Also:

setFooterTextColor(Color), FormPackage.getFormField_FooterTextColor()

setFooterTextColor

void setFooterTextColor(Color value)

Sets the value of the 'Footer Text Color' containment reference.

Parameters:

value - the new value of the 'Footer Text Color' containment reference.

See Also:

getFooterTextColor()

getFooterBackColor

Color getFooterBackColor()

Returns the value of the 'Footer Back Color' containment reference.

Returns:

the value of the 'Footer Back Color' containment reference.

See Also:

setFooterBackColor(Color), FormPackage.getFormField_FooterBackColor()

setFooterBackColor

void setFooterBackColor(Color value)

Sets the value of the 'Footer Back Color' containment reference.

Parameters:

value - the new value of the 'Footer Back Color' containment reference.

See Also:

getFooterBackColor()

getFooterFont

Font getFooterFont()

Returns the value of the 'Footer Font' containment reference.

Returns:

the value of the 'Footer Font' containment reference.

See Also:

setFooterFont(Font), FormPackage.getFormField_FooterFont()

setFooterFont

void setFooterFont(Font value)

Sets the value of the 'Footer Font' containment reference.

Parameters:

value - the new value of the 'Footer Font' containment reference.

See Also:

getFooterFont()

getFooterPicture

Picture getFooterPicture()

Returns the value of the 'Footer Picture' containment reference.

Returns:

the value of the 'Footer Picture' containment reference.

See Also:

setFooterPicture(Picture), FormPackage.getFormField_FooterPicture()

setFooterPicture

void setFooterPicture(Picture value)

Sets the value of the 'Footer Picture' containment reference.

Parameters:

value - the new value of the 'Footer Picture' containment reference.

See Also:

getFooterPicture()

getFooterHorizontalAlign

ItemHorizontalAlignment getFooterHorizontalAlign()

Returns the value of the 'Footer Horizontal Align' attribute. The literals are from the enumeration ItemHorizontalAlignment.

Returns:

the value of the 'Footer Horizontal Align' attribute.

See Also:

ItemHorizontalAlignment, setFooterHorizontalAlign(ItemHorizontalAlignment), FormPackage.getFormField_FooterHorizontalAlign()

setFooterHorizontalAlign

void setFooterHorizontalAlign(ItemHorizontalAlignment value)

Sets the value of the 'Footer Horizontal Align' attribute.

Parameters:

value - the new value of the 'Footer Horizontal Align' attribute.

See Also:

ItemHorizontalAlignment, getFooterHorizontalAlign()

getOnMainServerUnavalableBehavior

OnMainServerUnavalableBehavior getOnMainServerUnavalableBehavior()

Returns the value of the 'On Main Server Unavalable Behavior' attribute. The literals are from the enumeration OnMainServerUnavalableBehavior.

Returns:

the value of the 'On Main Server Unavalable Behavior' attribute.

See Also:

OnMainServerUnavalableBehavior, setOnMainServerUnavalableBehavior(OnMainServerUnavalableBehavior), FormPackage.getFormField_OnMainServerUnavalableBehavior()

setOnMainServerUnavalableBehavior

void setOnMainServerUnavalableBehavior(OnMainServerUnavalableBehavior value)

Sets the value of the 'On Main Server Unavalable Behavior' attribute.

Parameters:

value - the new value of the 'On Main Server Unavalable Behavior' attribute.

See Also:

OnMainServerUnavalableBehavior, getOnMainServerUnavalableBehavior()

getExtInfo

FieldExtInfo getExtInfo()

Returns the value of the 'Ext Info' containment reference.

Returns:

the value of the 'Ext Info' containment reference.

See Also:

setExtInfo(FieldExtInfo), FormPackage.getFormField_ExtInfo()

setExtInfo

void setExtInfo(FieldExtInfo value)

Sets the value of the 'Ext Info' containment reference.

Parameters:

value - the new value of the 'Ext Info' containment reference.

See Also:

getExtInfo()

validate

boolean validate(org.eclipse.emf.common.util.DiagnosticChain diagnostics,
                 Map<Object,Object> context)