C# Class SIL.FieldWorks.FdoUi.PhonologicalFeatureEditor

Inheritance: IBulkEditSpecControl, IFWDisposable
Show file Open project: sillsdev/FieldWorks

Protected Properties

Property Type Description
m_sda SIL.FieldWorks.Common.Controls.XMLViewsDataCache

Public Methods

Method Description
CheckDisposed ( ) : void

Check to see if the object has been disposed. All public Properties and Methods should call this before doing anything else.

ClearPreviousPreviews ( IEnumerable itemsToChange, int tagFakeFlid ) : void
Dispose ( ) : void

Must not be virtual.

DoIt ( IEnumerable itemsToChange, SIL.FieldWorks.Common.Controls.ProgressState state ) : void

Execute the change requested by the current selection in the combo. There are two main cases: 1. The user is removing a feature. 2. The user is using priority union to include the values of a feature structure. The latter has two subcases: a. The user has selected a value for the targeted feature and we have put that value in a FsFeatStruc. b. The user has employed the chooser to build a FsFeatStruc with the value(s) to change. These values may or may not be for the targeted feature. We do nothing to (phoneme) records where the check box is turned off. For phonemes with the check box on, we either 1. remove the specified feature from the phoneme or 2. use priority union to set the value(s) in the FsFeatStruc.

FakeDoit ( IEnumerable itemsToChange, int tagFakeFlid, int tagEnable, SIL.FieldWorks.Common.Controls.ProgressState state ) : void

Fake doing the change by setting the specified property to the appropriate value for each item in the set. Disable items that can't be set.

MakeSuggestions ( IEnumerable itemsToChange, int tagFakeFlid, int tagEnabled, SIL.FieldWorks.Common.Controls.ProgressState state ) : void

Used by SemanticDomainChooserBEditControl to make suggestions and then call FakeDoIt

PhonologicalFeatureEditor ( ) : System
PhonologicalFeatureEditor ( XmlNode configurationNode ) : System
SetClearField ( ) : void

Not needed since we said we can't do it.

Protected Methods

Method Description
Dispose ( bool disposing ) : void

Executes in two distinct scenarios. 1. If disposing is true, the method has been called directly or indirectly by a user's code via the Dispose method. Both managed and unmanaged resources can be disposed. 2. If disposing is false, the method has been called by the runtime from inside the finalizer and you should not reference (access) other managed objects, as they already have been garbage collected. Only unmanaged resources can be disposed.

If any exceptions are thrown, that is fine. If the method is being done in a finalizer, it will be ignored. If it is thrown by client code calling Dispose, it needs to be handled by fixing the bug. If subclasses override this method, they should call the base implementation.

Private Methods

Method Description
GetLabelToShow ( ) : string

This finds the value of the targeted feature in a FsFeatStruc

GetTargetFsFeatStruc ( ) : IFsFeatStruc
IsItemEligible ( ISilDataAccess sda, int hvo, ICmObject selectedObject, string labelToShow ) : bool
m_PhonFeaturePopupTreeManager_AfterSelect ( object sender, System e ) : void
m_tree_TreeLoad ( object sender, EventArgs e ) : void

Method Details

CheckDisposed() public method

Check to see if the object has been disposed. All public Properties and Methods should call this before doing anything else.
public CheckDisposed ( ) : void
return void

ClearPreviousPreviews() public method

public ClearPreviousPreviews ( IEnumerable itemsToChange, int tagFakeFlid ) : void
itemsToChange IEnumerable
tagFakeFlid int
return void

Dispose() public method

Must not be virtual.
public Dispose ( ) : void
return void

Dispose() protected method

Executes in two distinct scenarios. 1. If disposing is true, the method has been called directly or indirectly by a user's code via the Dispose method. Both managed and unmanaged resources can be disposed. 2. If disposing is false, the method has been called by the runtime from inside the finalizer and you should not reference (access) other managed objects, as they already have been garbage collected. Only unmanaged resources can be disposed.
If any exceptions are thrown, that is fine. If the method is being done in a finalizer, it will be ignored. If it is thrown by client code calling Dispose, it needs to be handled by fixing the bug. If subclasses override this method, they should call the base implementation.
protected Dispose ( bool disposing ) : void
disposing bool
return void

DoIt() public method

Execute the change requested by the current selection in the combo. There are two main cases: 1. The user is removing a feature. 2. The user is using priority union to include the values of a feature structure. The latter has two subcases: a. The user has selected a value for the targeted feature and we have put that value in a FsFeatStruc. b. The user has employed the chooser to build a FsFeatStruc with the value(s) to change. These values may or may not be for the targeted feature. We do nothing to (phoneme) records where the check box is turned off. For phonemes with the check box on, we either 1. remove the specified feature from the phoneme or 2. use priority union to set the value(s) in the FsFeatStruc.
public DoIt ( IEnumerable itemsToChange, SIL.FieldWorks.Common.Controls.ProgressState state ) : void
itemsToChange IEnumerable
state SIL.FieldWorks.Common.Controls.ProgressState
return void

FakeDoit() public method

Fake doing the change by setting the specified property to the appropriate value for each item in the set. Disable items that can't be set.
public FakeDoit ( IEnumerable itemsToChange, int tagFakeFlid, int tagEnable, SIL.FieldWorks.Common.Controls.ProgressState state ) : void
itemsToChange IEnumerable
tagFakeFlid int
tagEnable int
state SIL.FieldWorks.Common.Controls.ProgressState
return void

MakeSuggestions() public method

Used by SemanticDomainChooserBEditControl to make suggestions and then call FakeDoIt
public MakeSuggestions ( IEnumerable itemsToChange, int tagFakeFlid, int tagEnabled, SIL.FieldWorks.Common.Controls.ProgressState state ) : void
itemsToChange IEnumerable
tagFakeFlid int
tagEnabled int
state SIL.FieldWorks.Common.Controls.ProgressState
return void

PhonologicalFeatureEditor() public method

public PhonologicalFeatureEditor ( ) : System
return System

PhonologicalFeatureEditor() public method

public PhonologicalFeatureEditor ( XmlNode configurationNode ) : System
configurationNode System.Xml.XmlNode
return System

SetClearField() public method

Not needed since we said we can't do it.
public SetClearField ( ) : void
return void

Property Details

m_sda protected property

protected XMLViewsDataCache,SIL.FieldWorks.Common.Controls m_sda
return SIL.FieldWorks.Common.Controls.XMLViewsDataCache