Package com._1c.g5.aef2.components

Interface IComponent<M extends IModel>

All Superinterfaces:

IEventChannel

All Known Subinterfaces:

IManagingComponent<M>

All Known Implementing Classes:

com._1c.g5.v8.dt.form.ui.internal.chart.aef.components.reference.AbstractChartReferenceGridComponent, AbstractChoiceParameterLinksComponent, AbstractControlComponent, AbstractDependentProjectWizard.DependedRootObjectPage, AbstractDtActionBarComponent, AbstractDtActionBarHandlerSelectComponent, AbstractDtColorActionBarComponent, AbstractDtComboSelectComponent, AbstractDtEditableComboComponent, AbstractDtListActionBarComponent, AbstractDtReadonlyActionBarComponent, AbstractDtSelectComponent, AbstractGridComponent, AbstractGridWithToolbarComponent, AbstractMobileApplicationUrlsComponent, AbstractMultilanguageComponent, AbstractSelectionActionBarComponent, AbstractSelectionComponent, AbstractSelectionFromListDialogComponent, AbstractSelectionFromTreeDialogComponent, AbstractSingleLanguageComponent, AbstractTabFolderComponent, AbstractTypeLinkComponent, AddInUploadButtonsComponent, AddressingAttributesComponent, BigDecimalSpinnerComponent, BooleanComboComponent, ButtonComponent, CharacteristicsDescriptionDataPathComboComponent, CharacteristicsDescriptionFieldComboComponent, CharacteristicsDescriptionModelNewWizardPageComponent, ChartAxisValueDialogComponent, ChartColorPaletteDescriptionDialogComponent, ChartReferenceBandGridComponent, ChartReferenceBandsDialogComponent, ChartReferenceBandsDialogComponent.ChartReferenceBandsGridWithToolbarComponent, ChartReferenceLineGridComponent, ChartReferenceLinesDialogComponent, ChartReferenceLinesDialogComponent.ReferenceLinesGridWithToolbarComponent, ChartScaleDialogComponent, CheckableLabelComponent, CheckBoxComponent, ChoiceParameterLinksComponent, ChoiceParametersComponent, CodeComponent, ColorComponent, ComboComponent, ComboLabelComponent, CommonAttributeContentTreeComponent, CommonAttributeDataSeparationComponent, CommonPictureContentEditComponent, CommonPictureEntriesComponent, CommonPictureEntriesGridComponent, CommonPicturePreviewImageComponent, CommonPicturePreviewImageSizeComponent, Component, CompositeComponent, ConfigurationCompatibilityModeComponent, ConfigurationRequiredMobileApplicationPermissionComponent, ConfigurationStandaloneContentComponent, ConfigurationUsePurposesComponent, ContainerComponent, DataExchangeComponent, DcsChartReferenceBandGridComponent, DcsChartReferenceBandsDialogComponent, DcsChartReferenceLineGridComponent, DcsChartReferenceLinesDialogComponent, DefinitionDrivenComponent, DialogComponent, DialogWithToolbarComponent, DirectorySelectionComponent, DocumentEditorPostingPageComponent, DoubleSpinnerComponent, DtBorderStyleComponent, DtDateComponent, DtDynamicTableComponent, DtDynamicTreeComponent, DtGranularEditorPageAefComponent, DtGranularEditorPageSectionComponent, DtMappedCheckboxComponent, DtPictureComponent, DtTextComponent, DtValueActionBarComponent, EnumComponent, EnumRadioGroupComponent, EventHandlerCollectionComponent, EventSubscriptionEventsComboSelectComponent, EventSubscriptionHandlerSelectComponent, ExchangePlanContentComponent, ExtendedComboLabelComponent, ExtendedConfigurationObjectComponent, ExtendedFieldComponent, ExtendedLabelComponent, ExtendedTypeDescriptionComponent, ExtendedTypeDescriptionMultiStateComponent, FieldComponent, FileSelectionComponent, FontSelectionComponent, FormatStringComponent, FormSelectionComponent, FormWizardAttributesPage, GraphicalSchemeEventHandlerComponent, GraphicalSchemeLineComponent, GraphicalSchemePictureSelectionComponent, GraphicalSchemePictureStyleComponent, GridLayoutCompositeComponent, HandlerSelectComponent, HandlerSelectionComponent, HandlerSelectionComponent, ImageButtonComponent, InformationRegisterPeriodicityComponent, IntervalBoundComponent, LabelComponent, LinkComponent, ListSelectionComponent, LongSpinnerComponent, MainDataCompositionSchemeComponent, MdModelNewWizardPageComponent, MdPictureComponent, MdPropertyPaletteComponent, MdTypedModelNewWizardPageComponent, MinMaxValueComponent, MobileApplicationUrlsComponent, MobileDigiSignComponent, MoxelAreaComponent, MoxelPatternComponent, MoxelSpreadsheetLineComponent, MultilanguageComponent, MultilanguageFormattedTextComponent, NavigatorTableComponent, NavigatorTreeComponent, NavigatorTreeDialogActionBarComponent, NavigatorTreeDialogComponent, NewWizardPageComponent, NullableSpinnerComponent, NumberCodeMaxLengthSpinnerComponent, NumberMinMaxValueComponent, OpenChartEditorByLinkComponent, OpenDendrogramEditorByLinkComponent, OpenEditorByLinkComponent, OpenEditorInFormByLinkComponent, OpenGanttChartEditorByLinkComponent, OpenGeographicalSchemaEditorInFormByLinkComponent, OpenGraphicalSchemeEditorInFormByLinkComponent, OpenMdHelpComponent, OpenMoxelEditorByLinkComponent, OpenSuppressionSettingsEditorByLinkComponent, OpenTimeScaleEditorByLinkComponent, PackageDataComponent, PackageTreeToListSelectionComponent, PackageTreeToSingleItemSelectionComponent, PictureSelectionComponent, PictureSizeComponent, PredefinedAccountNewWizardPage, PredefinedCalculationTypeNewWizardPage, PredefinedCharacteristicTypeNewWizardPage, PredefinedDataComponent, PredefinedItemNewWizardPage, PropertyPaletteComponent, RadioGroupComponent, RadioGroupComponent, ReportFormSelectionComponent, RequiredPermissionsComponent, RootObjectPage, ScheduledJobMethodNameComponent, ScrolledCompositeComponent, SectionComponent, SectionDefinitionComponent, SeparatorComponent, ShortcutComponent, SignOfUnfilledParentComponent, SingleLanguageFormattedTextComponent, SourceUrlComponent, SpinnerComponent, StandardComponent, StandardObjectsTreeComponent, TableLocationComboSelectComponent, TextComponent, TextPreviewComponent, ToolBarComponent, TreeComponent, TreeToListSelectionComponent, TreeToSingleItemSelectionComponent, TrendlineArrayDialogComponent, TypeDescriptionComponent, TypeDescriptionDialogComponent, TypeLinkComponent, TypeNewWizardPageComponent, UnsettablePropertyFieldComponent, UsedMobileApplicationFunctionalitiesComponent, ValueComponent, ValueSelectionComponent, VersionedEnumComponent, XdtoPackagesComponent

public interface IComponent<M extends IModel>
extends IEventChannel

Defines contract of a component. Component is a basic building block of a IScene. Scene contains a tree of a components, components produces and maintains a tree of a view models, view models are rendered by the scene renderer.

Method Summary

Modifier and Type	Method	Description
boolean	areChildCommitsEnabled()
boolean	areChildRefreshEnabled()
void	beginExternalUpdate()	Begins the external update operation.
void	commit()	Commits this component changes to the model.
void	dispose()	Disposes this component, its view models and its child components.
void	endExternalUpdate()	Ends the external update operation.
Iterable<IComponent<?>>	getComponents()
M	getModel()
IComponent<?>	getParent()
IScene	getScene()
Collection<IServiceEventQualifier>	getServiceEventQualifiers()	Returns the collection of service event qualifiers that event should be traversed to component from event tracker.
Iterable<IViewModel>	getViewModels()
boolean	isDisposed()
boolean	isInExternalUpdate()
void	setChildCommitsEnabled(boolean value)
void	setChildRefreshEnable(boolean value)
void	setModel(M model)	Sets the model for this component.
void	setParent(IComponent<?> component)
void	setScene(IScene scene)

Methods inherited from interface com._1c.g5.aef2.events.IEventChannel

addListener, queueAndWaitEvent, queueEvent, removeListener

Method Detail

getScene

IScene getScene()

Returns:

the scene this component belongs to or null if component doesn't belong to a scene yet.

setScene

void setScene(IScene scene)

Parameters:

scene - the scene to place this component in.

getParent

IComponent<?> getParent()

Returns:

the parent component.

setParent

void setParent(IComponent<?> component)

Parameters:

component - a component to set as the parent component.

getComponents

Iterable<IComponent<?>> getComponents()

Returns:

the child components of this component.

getViewModels

Iterable<IViewModel> getViewModels()

Returns:

the view models produced by this component.

setModel

void setModel(M model)

Sets the model for this component. Component implementation may also accept the model from a constructor and call this method internally. Attaching listeners to the model should be postponed as long as possible, usually there are two safe points to start model listening: getComponents() or getViewModels() invocation.

Parameters:

model - the model to set.

getModel

M getModel()

Returns:

the model of this component or null if component has no associated model.

commit

void commit()

Commits this component changes to the model.

areChildCommitsEnabled

boolean areChildCommitsEnabled()

Returns:

true if child commits are allowed, false if child commits are inhibited and this component handles a commit by itself.

setChildCommitsEnabled

void setChildCommitsEnabled(boolean value)

Parameters:

value - true to enable child commits, false to disable them.

See Also:

areChildCommitsEnabled()

areChildRefreshEnabled

boolean areChildRefreshEnabled()

Returns:

true if child refreshing are allowed, false if child refreshing are inhibited and this component handles a refresh by itself.

setChildRefreshEnable

void setChildRefreshEnable(boolean value)

Parameters:

value - true to enable child refreshing, false to disable them.

See Also:

areChildRefreshEnabled()

beginExternalUpdate

void beginExternalUpdate()

Begins the external update operation. All direct changes of the models associated with this component are marked as ChangeOrigin.External. End the operation with endExternalUpdate() call, external update operations may be nested. All model direct write changes are marked as ChangeOrigin.Internal if no external update is in progress.

isInExternalUpdate

boolean isInExternalUpdate()

Returns:

true if external update operation is in progress, false otherwise.

See Also:

beginExternalUpdate()

endExternalUpdate

void endExternalUpdate()

Ends the external update operation.

See Also:

beginExternalUpdate()

getServiceEventQualifiers

Collection<IServiceEventQualifier> getServiceEventQualifiers()

Returns the collection of service event qualifiers that event should be traversed to component from event tracker.

Returns:

collection of event qualifiers.

See Also:

IServiceEventTracker.trackEvent(IServiceEvent)

dispose

void dispose()

Disposes this component, its view models and its child components.

isDisposed

boolean isDisposed()

Returns:

true if the component was disposed, false otherwise.