Changes between Version 26 and Version 27 of TEXT_VIEW_MODEL


Ignore:
Timestamp:
04/23/10 14:11:23 (15 years ago)
Author:
diana
Comment:

--

Legend:

Unmodified
Added
Removed
Modified

  • TEXT_VIEW_MODEL

    v26 v27  
    5454  * Usage: It is intended to draw the background highlight for the current quick search result. Since selection will also use a TestProcessor, the highlights() property somewhere in the text frame view, becomes unneeded. The quick search logic should stay unchanged, but the results will not be put in the highlights() property - they will be set as current options for the search processor.  
    5555  * Contents: 
    56    * TextSearchOptions - they only contain the HotTextInterval for the highlight and the highlight color. 
     56   * TextSearchOptions - they only contain the ImmTextInterval for the highlight and the highlight color. 
    5757 * Implement text link processor 
    5858  * Usage: The current text model has attributes with link Ids attached to the text units. The processor needs the colors associated with these IDs so it can set the text foreground - this way, the text will be drawn with different color in its link intervals. Any maps that map intervals to attachments will be removed - the only thing we need to map is link IDs. Methods like HeadTextFrameView.getExtraHighlights() should also be removed. 
    … …  
    6060   * TextLinkOptions - contains a map of strings to ImmColors. Nothing special here. 
    6161 
    62  * In org.sophie2.base.model.text.mvc package add new class public static class '''SelectionOptions<T>''' implements TextProcessor.Options - a class representing the options of the selection processor. This class has private final  HotAttr<T> attribute, private final T value, private final HotTextInterval selectionInterval. The first one holds the attribute of the selection (CommonAttr.BACKGROUND_COLOR), the second one holds it's value (Ex: ImmColor.Blue) and the third one holds the selection interval. 
    63  * In org.sophie2.base.model.text.mvc package add new class '''SelectionProcessor''' implements TextProcessor<SelectionOptions, DefaultTextEffect> - Processes text selection and caret.Its work consists of modifying some of the the color attributes for the selected chars, as well as to put a LayoutAttr#CARET_ATTR somewhere.  
     62 * In org.sophie2.base.model.text.mvc package add new class public static class '''SelectionOptions<T>''' implements TextProcessor.Options - a class representing the options of the selection processor. This class has private final  HotAttr<T> attribute, private final T value, private final ImmTextInterval selectionInterval. The first one holds the attribute of the selection (CommonAttr.BACKGROUND_COLOR), the second one holds it's value (Ex: ImmColor.Blue) and the third one holds the selection interval. 
     63 * In org.sophie2.base.model.text.mvc package add new class '''SelectionProcessor''' implements TextProcessor<SelectionOptions, DefaultTextEffect> - Processes text selection and caret.Its work consists of modifying some of the the color attributes for the selected chars. 
    6464 
    6565 
    … …  
    7070 This class has the following abstract functions: 
    7171   * '''public abstract ImmText applyTo(ImmText sourceText)''' - This method applies the current text change to a given text and returns new text with applied change. 
    72    * '''public abstract HotTextInterval getSourceDamage(ImmText sourceText)''' - Returns the damaged region (interval) from the source text. 
    73    * '''public abstract HotTextInterval getTargetDamage(ImmText sourceText)''' - Returns the damaged region (interval) from the target (text after the change is made to the source text) text. 
     72   * '''public abstract ImmTextInterval getSourceDamage(ImmText sourceText)''' - Returns the region (interval) from the source text that has been affected by the change 
     73   * '''public abstract ImmTextInterval getTargetDamage(ImmText sourceText)''' - Returns the region (interval) from the target text (text after the change is made to the source text) hat has been affected by the change. 
    7474   * '''public abstract int updateIndex(int index, ImmText sourceText)''' - Updates the given index. Ex: text: ASD, the change is deleting the A; update(2) will return 1. 
    75  * In org.sophie2.base.model.text add new class '''TextReplaceChange''' that extends TextChange. This class gives basic implementation of the TextChange's functions for a change representing replacing in the ImmText. This class has two private fields: ''final HotTextInterval interval'' and ''final ImmText substitution'' - the first one holds the interval that will be replaced and the second one holds the text for the substitution. The ''applyTo'' method simply calls ImmText#replace function. 
    76  * In org.sophie2.base.model.text package add class '''TextStyleChange''' that extends TextChange class. This class is basic implementation of the functions in TextChange class for changes in text that represent applying styles on ImmText. It has two private fields - ''final HotTextInterval interval'' and ''final HotStyleDef style''. The first one holds the interval that the styles will be applied to and the second one holds the styles. The ''applyTo'' method calls ImmText#applyStyle function. 
     75 * In org.sophie2.base.model.text add new class '''TextReplaceChange''' that extends TextChange. This class gives basic implementation of the TextChange's functions for a change representing replacing in the ImmText. This class has two private fields: ''final ImmTextInterval interval'' and ''final ImmText substitution'' - the first one holds the interval that will be replaced and the second one holds the text for the substitution. The ''applyTo'' method simply calls ImmText#replace function. 
     76 * In org.sophie2.base.model.text package add class '''TextStyleChange''' that extends TextChange class. This class is basic implementation of the functions in TextChange class for changes in text that represent applying styles on ImmText. It has two private fields - ''final ImmTextInterval interval'' and ''final HotStyleDef style''. The first one holds the interval that the styles will be applied to and the second one holds the styles. The ''applyTo'' method calls ImmText#applyStyle function. 
    7777 * In '''CommonAttr''' class add ''public static ImmList<HotAttr<?>> getAllAttr()'' function and remove the same from HotStyleDef class. This function gets all the attributes that are defined in the class. 
    78  * In '''CommonAttr''' class add new ''public static final HotAttr<Boolean> DUMMY_ATTRIBUTE'' - Attribute that is true only if the char is DOC_BREAK.This is needed because the last text run in the text layout has to consist only of the ''DOC_BREAK'' in order not to be drawn and not to be handled in complicated ways. 
     78 * In '''CommonAttr''' class add new ''public static final HotAttr<Boolean> END_TEXT_ATTRIBUTE - Attribute that is true only if the char is DOC_BREAK.This is needed because the last text run in the text layout has to consist only of the ''DOC_BREAK'' in order not to be drawn and not to be handled in complicated ways. 
    7979 * In '''ImmTextUtils''' class add new method: ''public static ImmText createDefaultText()'' - Creates a text with one char equal to ''DOC_BREAK''. 
    8080 * In org.sophie2.base.model.text.elements package add new final class : '''LayoutAttr''' that holds all the attributes that only the processors can apply to the text. 
    8181   * In '''LayoutAttr''' class add ''HotAttr<Boolean> CARET_ATTR'' - this attribute represents the caret in the view. True if the caret is before that char. 
    82  * In '''HotTextInterval''' class add new function: ''public HotTextInterval unite(HotTextInterval interval)'' - Unites two intervals - gets the largest possible interval from the given one and the current. 
    83  * In '''ImmTextUtils''' add new function: ''public static ImmText concat(ImmText text1, ImmText text2)'' - Concatenates the two given texts. Keeps the styles as the origin texts. 
    84  * Rename '''TextViewFlow''' to '''TextModel''' and add new functions as follows:  
     82 * In '''ImmTextInterval''' class add new function: ''public ImmTextInterval unite(ImmTextInterval interval)'' - Unites two intervals - gets the largest possible interval from the given one and the current. This is needed when the text processors setOptions and changeOptions is called - to reuse some of the processed text before the change. 
     83 * In '''ImmTextUtils''' add new function: ''public static ImmText concat(ImmText text1, ImmText text2)'' - Concatenates the two given texts. Keeps the styles as the origin texts. This is needed in the processors to add the DOC_BREAK in the end of the text and to keep its style. 
     84 * Rename '''TextViewFlow''' to '''TextModel''' , make it extend BaseProObject class and add new functions as follows:  
    8585   * '''public abstract ImmText getRawText()''' -  The text in the model. This is text without any attributes added for highlights, selection, etc. 
    8686   * '''public abstract ImmText getProcessedText()''' - The text that the layout use. This text differs from the raw text only by some text attributes (added for highlights, selection etc.) 
    … …  
    8888 * In org.sophie2.base.model.text.mvc package add new class abstract class '''BaseTextModel''' extends TextModel - Basic implementation of the methods from the TextModel abstract class. This class has function public void update(TextChange change) that applies the given change to the raw text and to the processed text and updates the indexes of the caret an the mark of the model. 
    8989 * In org.sophie2.base.model.text.mvc.swing package add new class: SwingTextModel extends BaseTextModel - The swing realization of the {@link TextModel} class. It is used only for testing. 
    90  * In org.sophie2.main.func.text.view package add new class : abstract class '''TextResourceModel''' extends BaseTextModel - Base implementation of the TextModel that connects the view with the text resource. It has one function: public void changeModel(final TextChange change, ResourceAccess access, 
    91  final ImmText text, boolean significant, String description) -  Method for updating the text model with a given TextChange. Changes the text resource, related to the view that holds the current TextResourceModel and updates the caret and mark posses to stay consistent. 
    92  * Make the class '''HeadTextModel''' extend TextResourceModel. 
     90 * In org.sophie2.main.func.text.view package add new class : abstract class '''ResourceTextModel''' extends BaseTextModel - Base implementation of the TextModel that connects the view with the text resource. It has one function: public void changeModel(final TextChange change, ResourceAccess access, 
     91 final ImmText text, boolean significant, String description) -  Method for updating the text model with a given TextChange. Changes the text resource, related to the view that holds the current ResourceTextModel and updates the caret and mark posses to stay consistent. 
     92 * Make the class '''HeadTextModel''' extend ResourceTextModel. 
    9393 * In HotTextLogic class rename ON_SET_TEXT to ON_CHANGE_TEXT and call the changeModel when the text needs to be changed in the model(replace the AutoAction part). 
    94   * In TextView class : EventIds rename the SET_TEXT to SET_CHANGE and set its event params to: 
     94  * In TextView class : EventIds rename the SET_TEXT to CHANGE_TEXT and set its event params to: 
    9595  TextChange.class, String.class, Boolean.class - the change to be made, the description of the action and the significance (if it can be undo/redo). 
    96  * In HotLayout, HotTextLayout, HotAreaLayout, HotLineLayout, HotSegmentLayout:draw method add another parameter : isEditable that is true if the book is not preview mode (this is used to show if the caret should be drawn). 
    97  
     96 * In org.sophie2.base.model.text.mvc pachage add new class CaretProcessor implements TextProcessor<CaretOptions, DefaultTextEffect> - Processes text with caret. It puts the LayoutAttr#CARET_ATTR somewhere. 
     97 * In CaretProcessor class add new class - CaretOptions implements TextProcessor.Options - Class representing the options of the caret processor. 
     98  * this class has two fvields : private final int caretPos and private final boolean withCaret - the first one represents the caret position in the 
     99current text and the second one is true only if the caret should be drawn. 
     100  * the class has a default constructor - public CaretOptions(int caretPos, boolean withCaret). 
     101  * public int getCaretPos() - Getter for the caret position. Returns the position of the caret(will be drawn before the char in the returned position).  
     102  * public boolean getWithCaret() -  Getter for the caret visibility. Returns true if the caret will be drawn, false otherwise.  
    98103 
    99104Tests : [browser:branches/private/diana/2384/modules/org.sophie2.base.model.text/src/test/java/org/sophie2/base/model/text/mvc/SelectionProcessorTest.java SelectionProcessorTest],