C# Class SIL.FieldWorks.XWorks.MorphologyEditor.AffixRuleFormulaControl

This class represents an affix process rule formula control. An affix process is represented by a left input empty cell, a right input empty cell, a cell for each input phonological context, and a result cell. The input emtpy cells are simply used to insert new contexts in to a MoAffixProcess. The context cells represent the contexts in the Input field of MoAffixProcess. The data in the result cell consists of the rule mapping objects in the Output field.

Inheritance: RuleFormulaControl

Show file Open project: sillsdev/FieldWorks Class Usage Examples

Private Properties

Property	Type	Description
CreateSeqCtxt	IPhSequenceContext
DisplayColumnOption	bool
DisplayIndices	IEnumerable
DisplayNoOptsMsg	string
DisplayOption	bool
DisplayVariableOption	bool
GetColumnInsertIndex	int
InsertContext	int
InsertIntoOutput	int
IsFinalLastVariableMapping	bool
IsLastVariable	bool
IsLastVariableMapping	bool
SelectionChanged	void
UpdateMappings	void

Public Methods

Method	Description
AffixRuleFormulaControl ( XmlNode configurationNode ) : System
Initialize ( SIL.FieldWorks.FDO.FdoCache cache, ICmObject obj, int flid, string fieldName, IPersistenceProvider persistProvider, XCore mediator, string displayNameProperty, string displayWs ) : void
SetMappingFeatures ( ) : void
SetMappingNaturalClass ( ) : void

Protected Methods

Method	Description
GetCell ( SelectionHelper sel, SelectionHelper limit ) : int
GetCellCount ( int cellId ) : int
GetCmObject ( SelectionHelper sel, SelectionHelper limit ) : ICmObject
GetFlid ( int cellId ) : int
GetItemCellIndex ( int cellId, ICmObject obj ) : int
GetLevelInfo ( int cellId, int cellIndex ) : SIL.FieldWorks.Common.COMInterfaces.SelLevInfo[]
GetNextCell ( int cellId ) : int
GetPrevCell ( int cellId ) : int
InsertBdry ( IPhBdryMarker bdry, SelectionHelper sel, int &cellIndex ) : int
InsertColumn ( SelectionHelper sel ) : int
InsertIndex ( int index, SelectionHelper sel, int &cellIndex ) : int
InsertNC ( IPhNaturalClass nc, SelectionHelper sel, int &cellIndex, IPhSimpleContextNC &ctxt ) : int
InsertPhoneme ( IPhPhoneme phoneme, SelectionHelper sel, int &cellIndex ) : int
InsertVariable ( SelectionHelper sel, int &cellIndex ) : int
OnSizeChanged ( EventArgs e ) : void
RemoveFromOutput ( bool forward, SelectionHelper sel, int &index ) : bool
RemoveItems ( SelectionHelper sel, bool forward, int &cellIndex ) : int

Private Methods

Method	Description
CreateSeqCtxt ( IPhPhonContext ctxt ) : IPhSequenceContext
DisplayColumnOption ( object option ) : bool
DisplayIndices ( ) : IEnumerable
DisplayNoOptsMsg ( ) : string
DisplayOption ( object option ) : bool
DisplayVariableOption ( object option ) : bool
GetColumnInsertIndex ( SelectionHelper sel ) : int
InsertContext ( IPhContextOrVar ctxtOrVar, SelectionHelper sel, int &cellIndex ) : int
InsertIntoOutput ( IMoRuleMapping mapping, SelectionHelper sel ) : int
IsFinalLastVariableMapping ( IMoRuleMapping mapping ) : bool
IsLastVariable ( IPhContextOrVar ctxtOrVar ) : bool
IsLastVariableMapping ( IMoRuleMapping mapping ) : bool
SelectionChanged ( object sender, EventArgs e ) : void
UpdateMappings ( IPhContextOrVar oldCtxtOrVar, IPhContextOrVar newCtxtOrVar ) : void	Updates the context that the mappings point to. This is used when the context changes from a single context to a sequence context.

Method Details

AffixRuleFormulaControl() public method

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

GetCell() protected method

protected GetCell ( SelectionHelper sel, SelectionHelper limit ) : int
sel	SIL.FieldWorks.Common.RootSites.SelectionHelper
limit	SIL.FieldWorks.Common.RootSites.SelectionHelper
return	int

GetCellCount() protected method

protected GetCellCount ( int cellId ) : int
cellId	int
return	int

GetCmObject() protected method

protected GetCmObject ( SelectionHelper sel, SelectionHelper limit ) : ICmObject
sel	SIL.FieldWorks.Common.RootSites.SelectionHelper
limit	SIL.FieldWorks.Common.RootSites.SelectionHelper
return	ICmObject

GetFlid() protected method

protected GetFlid ( int cellId ) : int
cellId	int
return	int

GetItemCellIndex() protected method

protected GetItemCellIndex ( int cellId, ICmObject obj ) : int
cellId	int
obj	ICmObject
return	int

GetLevelInfo() protected method

protected GetLevelInfo ( int cellId, int cellIndex ) : SIL.FieldWorks.Common.COMInterfaces.SelLevInfo[]
cellId	int
cellIndex	int
return	SIL.FieldWorks.Common.COMInterfaces.SelLevInfo[]

GetNextCell() protected method

protected GetNextCell ( int cellId ) : int
cellId	int
return	int

GetPrevCell() protected method

protected GetPrevCell ( int cellId ) : int
cellId	int
return	int

Initialize() public method

public Initialize ( SIL.FieldWorks.FDO.FdoCache cache, ICmObject obj, int flid, string fieldName, IPersistenceProvider persistProvider, XCore mediator, string displayNameProperty, string displayWs ) : void
cache	SIL.FieldWorks.FDO.FdoCache
obj	ICmObject
flid	int
fieldName	string
persistProvider	IPersistenceProvider
mediator	XCore
displayNameProperty	string
displayWs	string
return	void

InsertBdry() protected method

protected InsertBdry ( IPhBdryMarker bdry, SelectionHelper sel, int &cellIndex ) : int
bdry	IPhBdryMarker
sel	SIL.FieldWorks.Common.RootSites.SelectionHelper
cellIndex	int
return	int

InsertColumn() protected method

protected InsertColumn ( SelectionHelper sel ) : int
sel	SIL.FieldWorks.Common.RootSites.SelectionHelper
return	int

InsertIndex() protected method

protected InsertIndex ( int index, SelectionHelper sel, int &cellIndex ) : int
index	int
sel	SIL.FieldWorks.Common.RootSites.SelectionHelper
cellIndex	int
return	int

InsertNC() protected method

protected InsertNC ( IPhNaturalClass nc, SelectionHelper sel, int &cellIndex, IPhSimpleContextNC &ctxt ) : int
nc	IPhNaturalClass
sel	SIL.FieldWorks.Common.RootSites.SelectionHelper
cellIndex	int
ctxt	IPhSimpleContextNC
return	int

InsertPhoneme() protected method

protected InsertPhoneme ( IPhPhoneme phoneme, SelectionHelper sel, int &cellIndex ) : int
phoneme	IPhPhoneme
sel	SIL.FieldWorks.Common.RootSites.SelectionHelper
cellIndex	int
return	int

InsertVariable() protected method

protected InsertVariable ( SelectionHelper sel, int &cellIndex ) : int
sel	SIL.FieldWorks.Common.RootSites.SelectionHelper
cellIndex	int
return	int

OnSizeChanged() protected method

protected OnSizeChanged ( EventArgs e ) : void
e	System.EventArgs
return	void

RemoveFromOutput() protected method

protected RemoveFromOutput ( bool forward, SelectionHelper sel, int &index ) : bool
forward	bool
sel	SIL.FieldWorks.Common.RootSites.SelectionHelper
index	int
return	bool

RemoveItems() protected method

protected RemoveItems ( SelectionHelper sel, bool forward, int &cellIndex ) : int
sel	SIL.FieldWorks.Common.RootSites.SelectionHelper
forward	bool
cellIndex	int
return	int

SetMappingFeatures() public method

public SetMappingFeatures ( ) : void
return	void

SetMappingNaturalClass() public method

public SetMappingNaturalClass ( ) : void
return	void