Package com._1c.g5.v8.dt.form.model
Interface Form
- All Superinterfaces:
AbstractForm
,CommandBarHolder
,org.eclipse.emf.ecore.EObject
,EventHandlerContainer
,ExtensionAdoptedProperty
,FieldSource
,FormItemContainer
,FormStandardCommandSource
,FormVisualEntity
,IBmObject
,org.eclipse.emf.common.notify.Notifier
,Titled
- All Known Implementing Classes:
FormImpl
public interface Form
extends Titled, FormVisualEntity, FormItemContainer, CommandBarHolder, EventHandlerContainer, AbstractForm, FieldSource, FormStandardCommandSource, ExtensionAdoptedProperty
A representation of the model object 'Form'.
The following features are supported:
Width
Height
Window Opening Mode
Enter Key Behavior
Auto Save Data In Settings
Save Data In Settings
Save Window Settings
Settings Storage
Auto Title
Auto Url
Group
Children Align
Horizontal Spacing
Vertical Spacing
Horizontal Align
Vertical Align
Child Items Width
Auto Fill Check
Allow Form Customize
Enabled
Vertical Scroll
Scaling Mode
Scale
Show Title
Show Close Button
Conversations Representation
Collapse Items By Importance Variant
Mobile Device Command Bar Content
Base Form
Extension Form
Attributes
Conditional Appearance
Form Commands
Parameters
Command Interface
Ext Info
Command Panel Global Command Source
- See Also:
-
Field Summary
Fields inherited from interface com._1c.g5.v8.bm.core.IBmObject
BM_NULL_ID
-
Method Summary
Modifier and TypeMethodDescriptionorg.eclipse.emf.common.util.EList<ElementDataSourceInfo>
org.eclipse.emf.common.util.EList<FormAttribute>
Returns the value of the 'Attributes' containment reference list.Returns the value of the 'Auto Save Data In Settings' attribute.Returns the value of the 'Base Form' reference.Returns the value of the 'Child Items Width' attribute.Returns the value of the 'Children Align' attribute.Returns the value of the 'Collapse Items By Importance Variant' attribute.Returns the value of the 'Command Interface' containment reference.Returns the value of the 'Command Panel Global Command Source' containment reference.Returns the value of the 'Conditional Appearance' reference.Returns the value of the 'Conversations Representation' attribute.Returns the value of the 'Enter Key Behavior' attribute.Returns the value of the 'Extension Form' reference.Returns the value of the 'Ext Info' containment reference.org.eclipse.emf.common.util.EList<FormCommand>
Returns the value of the 'Form Commands' containment reference list.getGroup()
Returns the value of the 'Group' attribute.int
Returns the value of the 'Height' attribute.Returns the value of the 'Horizontal Align' attribute.Returns the value of the 'Horizontal Spacing' attribute.org.eclipse.emf.common.util.EList<ValueListItem>
Returns the value of the 'Mobile Device Command Bar Content' containment reference list.org.eclipse.emf.common.util.EList<FormParameter>
Returns the value of the 'Parameters' containment reference list.Returns the value of the 'Save Data In Settings' attribute.double
getScale()
Returns the value of the 'Scale' attribute.Returns the value of the 'Scaling Mode' attribute.Returns the value of the 'Settings Storage' reference.Returns the value of the 'Vertical Align' attribute.Returns the value of the 'Vertical Scroll' attribute.Returns the value of the 'Vertical Spacing' attribute.int
getWidth()
Returns the value of the 'Width' attribute.Returns the value of the 'Window Opening Mode' attribute.boolean
Returns the value of the 'Allow Form Customize' attribute.boolean
Returns the value of the 'Auto Fill Check' attribute.boolean
Returns the value of the 'Auto Title' attribute.boolean
Returns the value of the 'Auto Url' attribute.boolean
Returns the value of the 'Enabled' attribute.boolean
Returns the value of the 'Save Window Settings' attribute.boolean
Returns the value of the 'Show Close Button' attribute.boolean
Returns the value of the 'Show Title' attribute.org.eclipse.emf.common.util.EList<PropertyInfo>
void
setAllowFormCustomize
(boolean value) Sets the value of the 'Allow Form Customize
' attribute.void
setAutoFillCheck
(boolean value) Sets the value of the 'Auto Fill Check
' attribute.void
Sets the value of the 'Auto Save Data In Settings
' attribute.void
setAutoTitle
(boolean value) Sets the value of the 'Auto Title
' attribute.void
setAutoUrl
(boolean value) Sets the value of the 'Auto Url
' attribute.void
setBaseForm
(Form value) Sets the value of the 'Base Form
' reference.void
Sets the value of the 'Child Items Width
' attribute.void
Sets the value of the 'Children Align
' attribute.void
Sets the value of the 'Collapse Items By Importance Variant
' attribute.void
Sets the value of the 'Command Interface
' containment reference.void
Sets the value of the 'Command Panel Global Command Source
' containment reference.void
Sets the value of the 'Conditional Appearance
' reference.void
Sets the value of the 'Conversations Representation
' attribute.void
setEnabled
(boolean value) Sets the value of the 'Enabled
' attribute.void
Sets the value of the 'Enter Key Behavior
' attribute.void
setExtensionForm
(Form value) Sets the value of the 'Extension Form
' reference.void
setExtInfo
(FormExtInfo value) Sets the value of the 'Ext Info
' containment reference.void
setGroup
(FormChildrenGroup value) Sets the value of the 'Group
' attribute.void
setHeight
(int value) Sets the value of the 'Height
' attribute.void
Sets the value of the 'Horizontal Align
' attribute.void
Sets the value of the 'Horizontal Spacing
' attribute.void
Sets the value of the 'Save Data In Settings
' attribute.void
setSaveWindowSettings
(boolean value) Sets the value of the 'Save Window Settings
' attribute.void
setScale
(double value) Sets the value of the 'Scale
' attribute.void
Sets the value of the 'Scaling Mode
' attribute.void
Sets the value of the 'Settings Storage
' reference.void
setShowCloseButton
(boolean value) Sets the value of the 'Show Close Button
' attribute.void
setShowTitle
(boolean value) Sets the value of the 'Show Title
' attribute.void
Sets the value of the 'Vertical Align
' attribute.void
Sets the value of the 'Vertical Scroll
' attribute.void
Sets the value of the 'Vertical Spacing
' attribute.void
setWidth
(int value) Sets the value of the 'Width
' attribute.void
Sets the value of the 'Window Opening Mode
' attribute.boolean
Methods inherited from interface com._1c.g5.v8.dt.metadata.mdclass.AbstractForm
getFormContext, getFormEvents, getMdForm, getModule, setFormContext, setMdForm, setModule
Methods inherited from interface com._1c.g5.v8.dt.form.model.CommandBarHolder
getAutoCommandBar, getCommandBarLocation, setAutoCommandBar, setCommandBarLocation
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.ExtensionAdoptedProperty
getAdopted, getUnchanged, setAdopted, setUnchanged
Methods inherited from interface com._1c.g5.v8.dt.mcore.FieldSource
getFields, getRefFieldSources
Methods inherited from interface com._1c.g5.v8.dt.form.model.FormItemContainer
getItems
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, bmGetNamespace, bmGetPlatformTransaction, bmGetProperties, bmGetProperty, bmGetReferences, bmGetResourceId, bmGetTopObject, bmGetTransaction, bmGetUri, bmGetUriAsString, bmIsTop, bmIsTransient, bmMatchSingleReference, bmSetProperty
Methods inherited from interface org.eclipse.emf.common.notify.Notifier
eAdapters, eDeliver, eNotify, eSetDeliver
-
Method Details
-
getWidth
int getWidth()Returns the value of the 'Width' attribute.- Returns:
- the value of the 'Width' attribute.
- See Also:
-
setWidth
void setWidth(int value) Sets the value of the 'Width
' attribute.- Parameters:
value
- the new value of the 'Width' attribute.- See Also:
-
getHeight
int getHeight()Returns the value of the 'Height' attribute.- Returns:
- the value of the 'Height' attribute.
- See Also:
-
setHeight
void setHeight(int value) Sets the value of the 'Height
' attribute.- Parameters:
value
- the new value of the 'Height' attribute.- See Also:
-
getWindowOpeningMode
FormWindowOpeningMode getWindowOpeningMode()Returns the value of the 'Window Opening Mode' attribute. The literals are from the enumerationFormWindowOpeningMode
.- Returns:
- the value of the 'Window Opening Mode' attribute.
- See Also:
-
setWindowOpeningMode
Sets the value of the 'Window Opening Mode
' attribute.- Parameters:
value
- the new value of the 'Window Opening Mode' attribute.- See Also:
-
getEnterKeyBehavior
FormEnterKeyBehavior getEnterKeyBehavior()Returns the value of the 'Enter Key Behavior' attribute. The literals are from the enumerationFormEnterKeyBehavior
.- Returns:
- the value of the 'Enter Key Behavior' attribute.
- See Also:
-
setEnterKeyBehavior
Sets the value of the 'Enter Key Behavior
' attribute.- Parameters:
value
- the new value of the 'Enter Key Behavior' attribute.- See Also:
-
getAutoSaveDataInSettings
AutoSaveFormDataInSettings getAutoSaveDataInSettings()Returns the value of the 'Auto Save Data In Settings' attribute. The literals are from the enumerationAutoSaveFormDataInSettings
.- Returns:
- the value of the 'Auto Save Data In Settings' attribute.
- See Also:
-
setAutoSaveDataInSettings
Sets the value of the 'Auto Save Data In Settings
' attribute.- Parameters:
value
- the new value of the 'Auto Save Data In Settings' attribute.- See Also:
-
getSaveDataInSettings
SaveFormDataInSettings getSaveDataInSettings()Returns the value of the 'Save Data In Settings' attribute. The literals are from the enumerationSaveFormDataInSettings
.- Returns:
- the value of the 'Save Data In Settings' attribute.
- See Also:
-
setSaveDataInSettings
Sets the value of the 'Save Data In Settings
' attribute.- Parameters:
value
- the new value of the 'Save Data In Settings' attribute.- See Also:
-
isSaveWindowSettings
boolean isSaveWindowSettings()Returns the value of the 'Save Window Settings' attribute.- Returns:
- the value of the 'Save Window Settings' attribute.
- See Also:
-
setSaveWindowSettings
void setSaveWindowSettings(boolean value) Sets the value of the 'Save Window Settings
' attribute.- Parameters:
value
- the new value of the 'Save Window Settings' attribute.- See Also:
-
getSettingsStorage
SettingsStorage getSettingsStorage()Returns the value of the 'Settings Storage' reference.- Returns:
- the value of the 'Settings Storage' reference.
- See Also:
-
setSettingsStorage
Sets the value of the 'Settings Storage
' reference.- Parameters:
value
- the new value of the 'Settings Storage' reference.- See Also:
-
isAutoTitle
boolean isAutoTitle()Returns the value of the 'Auto Title' attribute.- Returns:
- the value of the 'Auto Title' attribute.
- See Also:
-
setAutoTitle
void setAutoTitle(boolean value) Sets the value of the 'Auto Title
' attribute.- Parameters:
value
- the new value of the 'Auto Title' attribute.- See Also:
-
isAutoUrl
boolean isAutoUrl()Returns the value of the 'Auto Url' attribute.- Returns:
- the value of the 'Auto Url' attribute.
- See Also:
-
setAutoUrl
void setAutoUrl(boolean value) Sets the value of the 'Auto Url
' attribute.- Parameters:
value
- the new value of the 'Auto Url' attribute.- See Also:
-
getGroup
FormChildrenGroup getGroup()Returns the value of the 'Group' attribute. The literals are from the enumerationFormChildrenGroup
.- Returns:
- the value of the 'Group' attribute.
- See Also:
-
setGroup
Sets the value of the 'Group
' attribute.- Parameters:
value
- the new value of the 'Group' attribute.- See Also:
-
getChildrenAlign
FormChildrenAlign getChildrenAlign()Returns the value of the 'Children Align' attribute. The literals are from the enumerationFormChildrenAlign
.- Returns:
- the value of the 'Children Align' attribute.
- See Also:
-
setChildrenAlign
Sets the value of the 'Children Align
' attribute.- Parameters:
value
- the new value of the 'Children Align' attribute.- See Also:
-
getHorizontalSpacing
FormItemSpacing getHorizontalSpacing()Returns the value of the 'Horizontal Spacing' attribute. The literals are from the enumerationFormItemSpacing
.- Returns:
- the value of the 'Horizontal Spacing' attribute.
- See Also:
-
setHorizontalSpacing
Sets the value of the 'Horizontal Spacing
' attribute.- Parameters:
value
- the new value of the 'Horizontal Spacing' attribute.- See Also:
-
getVerticalSpacing
FormItemSpacing getVerticalSpacing()Returns the value of the 'Vertical Spacing' attribute. The literals are from the enumerationFormItemSpacing
.- Returns:
- the value of the 'Vertical Spacing' attribute.
- See Also:
-
setVerticalSpacing
Sets the value of the 'Vertical Spacing
' attribute.- Parameters:
value
- the new value of the 'Vertical Spacing' attribute.- See Also:
-
getHorizontalAlign
ItemHorizontalAlignment getHorizontalAlign()Returns the value of the 'Horizontal Align' attribute. The literals are from the enumerationItemHorizontalAlignment
.- Returns:
- the value of the 'Horizontal Align' attribute.
- See Also:
-
setHorizontalAlign
Sets the value of the 'Horizontal Align
' attribute.- Parameters:
value
- the new value of the 'Horizontal Align' attribute.- See Also:
-
getVerticalAlign
ItemVerticalAlignment getVerticalAlign()Returns the value of the 'Vertical Align' attribute. The literals are from the enumerationItemVerticalAlignment
.- Returns:
- the value of the 'Vertical Align' attribute.
- See Also:
-
setVerticalAlign
Sets the value of the 'Vertical Align
' attribute.- Parameters:
value
- the new value of the 'Vertical Align' attribute.- See Also:
-
getChildItemsWidth
FormChildrenWidth getChildItemsWidth()Returns the value of the 'Child Items Width' attribute. The literals are from the enumerationFormChildrenWidth
.- Returns:
- the value of the 'Child Items Width' attribute.
- See Also:
-
setChildItemsWidth
Sets the value of the 'Child Items Width
' attribute.- Parameters:
value
- the new value of the 'Child Items Width' attribute.- See Also:
-
isAutoFillCheck
boolean isAutoFillCheck()Returns the value of the 'Auto Fill Check' attribute.- Returns:
- the value of the 'Auto Fill Check' attribute.
- See Also:
-
setAutoFillCheck
void setAutoFillCheck(boolean value) Sets the value of the 'Auto Fill Check
' attribute.- Parameters:
value
- the new value of the 'Auto Fill Check' attribute.- See Also:
-
isAllowFormCustomize
boolean isAllowFormCustomize()Returns the value of the 'Allow Form Customize' attribute.- Returns:
- the value of the 'Allow Form Customize' attribute.
- See Also:
-
setAllowFormCustomize
void setAllowFormCustomize(boolean value) Sets the value of the 'Allow Form Customize
' attribute.- Parameters:
value
- the new value of the 'Allow Form Customize' attribute.- See Also:
-
isEnabled
boolean isEnabled()Returns the value of the 'Enabled' attribute.- Returns:
- the value of the 'Enabled' attribute.
- See Also:
-
setEnabled
void setEnabled(boolean value) Sets the value of the 'Enabled
' attribute.- Parameters:
value
- the new value of the 'Enabled' attribute.- See Also:
-
getVerticalScroll
LogFormScrollMode getVerticalScroll()Returns the value of the 'Vertical Scroll' attribute. The literals are from the enumerationLogFormScrollMode
.- Returns:
- the value of the 'Vertical Scroll' attribute.
- See Also:
-
setVerticalScroll
Sets the value of the 'Vertical Scroll
' attribute.- Parameters:
value
- the new value of the 'Vertical Scroll' attribute.- See Also:
-
getScalingMode
FormBaseFontVariant getScalingMode()Returns the value of the 'Scaling Mode' attribute. The literals are from the enumerationFormBaseFontVariant
.- Returns:
- the value of the 'Scaling Mode' attribute.
- See Also:
-
setScalingMode
Sets the value of the 'Scaling Mode
' attribute.- Parameters:
value
- the new value of the 'Scaling Mode' attribute.- See Also:
-
getScale
double getScale()Returns the value of the 'Scale' attribute. The default value is"100"
.- Returns:
- the value of the 'Scale' attribute.
- See Also:
-
setScale
void setScale(double value) Sets the value of the 'Scale
' attribute.- Parameters:
value
- the new value of the 'Scale' attribute.- See Also:
-
isShowTitle
boolean isShowTitle()Returns the value of the 'Show Title' attribute.- Returns:
- the value of the 'Show Title' attribute.
- See Also:
-
setShowTitle
void setShowTitle(boolean value) Sets the value of the 'Show Title
' attribute.- Parameters:
value
- the new value of the 'Show Title' attribute.- See Also:
-
isShowCloseButton
boolean isShowCloseButton()Returns the value of the 'Show Close Button' attribute.- Returns:
- the value of the 'Show Close Button' attribute.
- See Also:
-
setShowCloseButton
void setShowCloseButton(boolean value) Sets the value of the 'Show Close Button
' attribute.- Parameters:
value
- the new value of the 'Show Close Button' attribute.- See Also:
-
getConversationsRepresentation
FormConversationsRepresentation getConversationsRepresentation()Returns the value of the 'Conversations Representation' attribute. The literals are from the enumerationFormConversationsRepresentation
.- Returns:
- the value of the 'Conversations Representation' attribute.
- See Also:
-
setConversationsRepresentation
Sets the value of the 'Conversations Representation
' attribute.- Parameters:
value
- the new value of the 'Conversations Representation' attribute.- See Also:
-
getCollapseItemsByImportanceVariant
CollapseFormItemsByImportance getCollapseItemsByImportanceVariant()Returns the value of the 'Collapse Items By Importance Variant' attribute. The literals are from the enumerationCollapseFormItemsByImportance
.- Returns:
- the value of the 'Collapse Items By Importance Variant' attribute.
- See Also:
-
setCollapseItemsByImportanceVariant
Sets the value of the 'Collapse Items By Importance Variant
' attribute.- Parameters:
value
- the new value of the 'Collapse Items By Importance Variant' attribute.- See Also:
-
getMobileDeviceCommandBarContent
org.eclipse.emf.common.util.EList<ValueListItem> getMobileDeviceCommandBarContent()Returns the value of the 'Mobile Device Command Bar Content' containment reference list. The list contents are of typeValueListItem
.- Returns:
- the value of the 'Mobile Device Command Bar Content' containment reference list.
- See Also:
-
getBaseForm
Form getBaseForm()Returns the value of the 'Base Form' reference.- Returns:
- the value of the 'Base Form' reference.
- See Also:
-
setBaseForm
Sets the value of the 'Base Form
' reference.- Parameters:
value
- the new value of the 'Base Form' reference.- See Also:
-
getExtensionForm
Form getExtensionForm()Returns the value of the 'Extension Form' reference.- Returns:
- the value of the 'Extension Form' reference.
- See Also:
-
setExtensionForm
Sets the value of the 'Extension Form
' reference.- Parameters:
value
- the new value of the 'Extension Form' reference.- See Also:
-
getAttributes
org.eclipse.emf.common.util.EList<FormAttribute> getAttributes()Returns the value of the 'Attributes' containment reference list. The list contents are of typeFormAttribute
.- Returns:
- the value of the 'Attributes' containment reference list.
- See Also:
-
getConditionalAppearance
DataCompositionConditionalAppearance getConditionalAppearance()Returns the value of the 'Conditional Appearance' reference.- Returns:
- the value of the 'Conditional Appearance' reference.
- See Also:
-
setConditionalAppearance
Sets the value of the 'Conditional Appearance
' reference.- Parameters:
value
- the new value of the 'Conditional Appearance' reference.- See Also:
-
getFormCommands
org.eclipse.emf.common.util.EList<FormCommand> getFormCommands()Returns the value of the 'Form Commands' containment reference list. The list contents are of typeFormCommand
.- Returns:
- the value of the 'Form Commands' containment reference list.
- See Also:
-
getParameters
org.eclipse.emf.common.util.EList<FormParameter> getParameters()Returns the value of the 'Parameters' containment reference list. The list contents are of typeFormParameter
.- Returns:
- the value of the 'Parameters' containment reference list.
- See Also:
-
getCommandInterface
FormCommandInterface getCommandInterface()Returns the value of the 'Command Interface' containment reference.- Returns:
- the value of the 'Command Interface' containment reference.
- See Also:
-
setCommandInterface
Sets the value of the 'Command Interface
' containment reference.- Parameters:
value
- the new value of the 'Command Interface' containment reference.- See Also:
-
getExtInfo
FormExtInfo getExtInfo()Returns the value of the 'Ext Info' containment reference.- Returns:
- the value of the 'Ext Info' containment reference.
- See Also:
-
setExtInfo
Sets the value of the 'Ext Info
' containment reference.- Parameters:
value
- the new value of the 'Ext Info' containment reference.- See Also:
-
getCommandPanelGlobalCommandSource
FormCommandPanelGlobalCommandSource getCommandPanelGlobalCommandSource()Returns the value of the 'Command Panel Global Command Source' containment reference.- Returns:
- the value of the 'Command Panel Global Command Source' containment reference.
- See Also:
-
setCommandPanelGlobalCommandSource
Sets the value of the 'Command Panel Global Command Source
' containment reference.- Parameters:
value
- the new value of the 'Command Panel Global Command Source' containment reference.- See Also:
-
propertyInfos
org.eclipse.emf.common.util.EList<PropertyInfo> propertyInfos() -
elementDataSourceInfos
org.eclipse.emf.common.util.EList<ElementDataSourceInfo> elementDataSourceInfos() -
validate
boolean validate(org.eclipse.emf.common.util.DiagnosticChain diagnostics, Map<Object, Object> context)
-