C# Class SIL.FieldWorks.FdoUi.BulkPosEditorBase

BulkPosEditor is the spec/display component of the Bulk Edit bar used to set the PartOfSpeech of group of LexSenses (actually by creating or modifying an MoStemMsa that is the MorphoSyntaxAnalysis of the sense). It was originally part of XmlViews, but it needs to use the POSPopupTreeManager class, and since FdoUi references XmlViews, XmlViews can't reference FdoUi. Also, it sort of makes sense to put it here as a class that is quite specific to a particular part of the model.

Inheritance: IBulkEditSpecControl, IFWDisposable, ITextChangedNotification

Show file Open project: sillsdev/FieldWorks

Protected Properties

Property	Type	Description
m_cache	SIL.FieldWorks.FDO.FdoCache
m_mediator	Mediator
m_pOSPopupTreeManager	POSPopupTreeManager
m_sda	XMLViewsDataCache
m_selectedHvo	int
m_selectedLabel	string
m_tree	TreeCombo

Public Methods

Method	Description
BulkPosEditorBase ( ) : System
CheckDisposed ( ) : void	Check to see if the object has been disposed. All public Properties and Methods should call this before doing anything else.
ControlTextChanged ( ) : void	Inform the editor that the text of the tree changed (without changing the selected index... that needs to be updated).
Dispose ( ) : void	Must not be virtual.
DoIt ( IEnumerable itemsToChange, SIL.FieldWorks.Common.Controls.ProgressState state ) : void
FakeDoit ( IEnumerable itemsToChange, int tagFakeFlid, int tagEnable, SIL.FieldWorks.Common.Controls.ProgressState state ) : void
MakeSuggestions ( IEnumerable itemsToChange, int tagFakeFlid, int tagEnabled, SIL.FieldWorks.Common.Controls.ProgressState state ) : void	Used by SemanticDomainChooserBEditControl to make suggestions and then call FakeDoIt
SetClearField ( ) : void	Subclasses should override if they override CanClearField to return true.

Protected Methods

Method	Description
CanFakeIt ( int hvo ) : bool
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
SelectNode ( TreeNode node ) : void
m_pOSPopupTreeManager_AfterSelect ( object sender, TreeViewEventArgs e ) : void
m_tree_TreeLoad ( object sender, EventArgs e ) : void

Method Details

BulkPosEditorBase() public method

public BulkPosEditorBase ( ) : System
return	System

CanFakeIt() protected abstract method

protected abstract CanFakeIt ( int hvo ) : bool
hvo	int
return	bool

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

ControlTextChanged() public method

Inform the editor that the text of the tree changed (without changing the selected index... that needs to be updated).

public ControlTextChanged ( ) : void
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 abstract method

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

FakeDoit() public method

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

SetClearField() public method

Subclasses should override if they override CanClearField to return true.

public SetClearField ( ) : void
return	void

Property Details

m_cache protected property

protected FdoCache,SIL.FieldWorks.FDO m_cache
return	SIL.FieldWorks.FDO.FdoCache

m_mediator protected property

protected Mediator m_mediator
return	Mediator

m_pOSPopupTreeManager protected property

protected POSPopupTreeManager m_pOSPopupTreeManager
return	POSPopupTreeManager

m_sda protected property

protected XMLViewsDataCache m_sda
return	XMLViewsDataCache

m_selectedHvo protected property

protected int m_selectedHvo
return	int

m_selectedLabel protected property

protected string m_selectedLabel
return	string

m_tree protected property

protected TreeCombo m_tree
return	TreeCombo