Package com._1c.g5.v8.dt.dcs.ui.settings
Interface IDcsSettingsProvider
-
- All Superinterfaces:
IDcsEnvironmentProvider
,IDcsListener
- All Known Implementing Classes:
ConditionalAppearance
,DataCompositionFilterDialog
,DataCompositionGroupFieldsDialog
,DataCompositionSettingsDialog
,FormConditionalAppearanceSettingsService
,Settings
,SettingsDialog
,UserFieldsCaseDialog
,UserFieldsExpressionDialog
public interface IDcsSettingsProvider extends IDcsListener, IDcsEnvironmentProvider
Provider of some information for available fields folders (currentDataCompositionSettings
model object, current available field, current available field destination, etc.)
-
-
Nested Class Summary
Nested Classes Modifier and Type Interface Description static class
IDcsSettingsProvider.TabKind
Kind of settings tab
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description DcsAvailableSettingsSourceForSchema
getAvailableFieldsSource()
Get source of available fieldsDcsAvailableSettingsSourceForSchema.FieldUse
getAvailableFieldsUse()
Get available fields variant (Filter, Order, etc.)Object
getCurrentObject()
Get current object.IDcsSettingsProvider.TabKind
getCurrentTabKind()
Get current tab kindObject
getDestinationForAvailableField()
Get parent destination object in main viewer for available fieldDcsAvailableSettingsSourceForSchema.FieldUse
getExpressionsFieldsUse()
Get expressions fields variantString
getFieldTitle(DataCompositionField field)
Get title for fieldString
getNestedSchemaName()
Get nested schema nameDataCompositionSchema
getSchema()
Get dcs schemaList<DcsAvailableFieldInfo>
getSelectedAvailableFields()
Get info of selected available fields in current folderObject
getSelectedObject()
Get selected object (selected node in structure tree or main object).List<Object>
getSelectedViewerNodes()
Get selected objects in main viewer (destination)DataCompositionSettings
getSettings()
GetDataCompositionSettings
model objectboolean
isUserFieldsAvailable()
Check whether user fields is availablevoid
setExpressionsFieldsUse(DcsAvailableSettingsSourceForSchema.FieldUse fieldUse)
Set expressions fields variantvoid
updateAvailableFieldsSource()
Update source of available fields-
Methods inherited from interface com._1c.g5.v8.dt.dcs.ui.IDcsEnvironmentProvider
getBmModel, getCurrentLanguageCode, getEditingContext, getV8project, getVersion
-
Methods inherited from interface com._1c.g5.v8.dt.dcs.ui.IDcsListener
notify
-
-
-
-
Method Detail
-
getSchema
DataCompositionSchema getSchema()
Get dcs schema- Returns:
- schema, can be null
-
getSettings
DataCompositionSettings getSettings()
GetDataCompositionSettings
model object- Returns:
DataCompositionSettings
model object
-
getAvailableFieldsSource
DcsAvailableSettingsSourceForSchema getAvailableFieldsSource()
Get source of available fields- Returns:
DcsAvailableSettingsSourceForSchema
object
-
updateAvailableFieldsSource
void updateAvailableFieldsSource()
Update source of available fields
-
getSelectedAvailableFields
List<DcsAvailableFieldInfo> getSelectedAvailableFields()
Get info of selected available fields in current folder- Returns:
- list of
DcsAvailableFieldInfo
objects, never null
-
getSelectedViewerNodes
List<Object> getSelectedViewerNodes()
Get selected objects in main viewer (destination)- Returns:
- list of selected objects, never null
-
getDestinationForAvailableField
Object getDestinationForAvailableField()
Get parent destination object in main viewer for available field- Returns:
- parent destination object
-
getAvailableFieldsUse
DcsAvailableSettingsSourceForSchema.FieldUse getAvailableFieldsUse()
Get available fields variant (Filter, Order, etc.)- Returns:
- available fields variant
-
getSelectedObject
Object getSelectedObject()
Get selected object (selected node in structure tree or main object). Object can be one ofDataCompositionSettings
,StructureItem
,DataCompositionTableGroup
,DataCompositionChartGroup
- Returns:
- selected object, never null
-
getCurrentObject
Object getCurrentObject()
Get current object. Object can be one ofDataCompositionSettings
,StructureItem
,DataCompositionTableGroup
,DataCompositionChartGroup
- Returns:
- current object, never null
-
getExpressionsFieldsUse
DcsAvailableSettingsSourceForSchema.FieldUse getExpressionsFieldsUse()
Get expressions fields variant- Returns:
- expressions fields variant
-
setExpressionsFieldsUse
void setExpressionsFieldsUse(DcsAvailableSettingsSourceForSchema.FieldUse fieldUse)
Set expressions fields variant- Parameters:
fieldUse
- expressions fields variant
-
isUserFieldsAvailable
boolean isUserFieldsAvailable()
Check whether user fields is available- Returns:
- whether user fields is available
-
getFieldTitle
String getFieldTitle(DataCompositionField field)
Get title for field- Parameters:
field
- field, can't be null- Returns:
- title, never null
-
getCurrentTabKind
IDcsSettingsProvider.TabKind getCurrentTabKind()
Get current tab kind- Returns:
IDcsSettingsProvider.TabKind
value, never null
-
getNestedSchemaName
String getNestedSchemaName()
Get nested schema name- Returns:
- nested schema name, never null (empty for the main schema)
-
-