| 76 | | * public abstract ImmText applyTo(ImmText sourceText) - This method applies the current text change to a given text and |
| 77 | | returns new text with applied change. |
| 78 | | * public abstract HotTextInterval getSourceDamage(ImmText sourceText) - Returns the damaged region (interval) |
| 79 | | from the source text. |
| 80 | | * public abstract HotTextInterval getTargetDamage(ImmText sourceText) - Returns the damaged region |
| 81 | | (interval) from the target (text after the change is made to the source text) text. |
| 82 | | * public abstract int updateIndex(int index, ImmText sourceText) - Updates the given index. |
| 83 | | Ex: text: ASD the change is deleting the A update(2) will return 1. |
| 84 | | * In org.sophie2.base.model.text add new class TextReplaceChange that extends TextChange. This class |
| 85 | | gives basic implementation of the TextChange's functions for a change representing replacing in the ImmText. |
| 86 | | This class has two private fields: final HotTextInterval interval and final ImmText substitution - the first |
| 87 | | one is holds the interval that will be replaced and the second one holds the text for the substitution. |
| 88 | | The applyTo method simply calls ImmText#replace function. |
| 89 | | * In org.sophie2.base.model.text package add class TextStyleChange that extends TextChange class. |
| 90 | | This class is basic implementation of the functions in TextChange class for changes in text |
| 91 | | that represent applying styles on ImmText. It has two private fields - final HotTextInterval interval and |
| 92 | | final HotStyleDef style. The first one holds the interval that the styles will be applied to and the second one |
| 93 | | holds the styles. The applyTo method calls ImmText#applyStyle function. |
| 94 | | * In CommonAttr class add public static ImmList<HotAttr<?>> getAllAttr() function and remove the same from HotStyleDef |
| 95 | | class. This function gets all the attributes that are defined in the class. |
| 96 | | * In CommonAttr class add new public static final HotAttr<Boolean> DUMMY_ATTRIBUTE - |
| 97 | | Attribute that is true only if the char is EMPTY_CHAR.This is needed because the last text run in the text layout has to consist only of the EMPTY_CHAR in order not to be drawn and not to be handled in complicated ways. |
| 98 | | * In ImmTextUtils class add new method: public static ImmText createDefaultText() - Creates a text with one char equal to EMPTY_CHAR. |
| 99 | | * In org.sophie2.base.model.text.elements package add new final class : LayoutAttr that holds all the attributes |
| 100 | | that only the processors can apply to the text. |
| 101 | | * In LayoutAttr class add HotAttr<Boolean> CARET_ATTR - this attribute represents the caret in the view. True if the caret is before that char. |
| 102 | | * In CommonChar class add static final char EMPTY_CHAR - A dummy char inserted at the end of a text to help |
| 103 | | the text navigation.Used only in the layout. |
| 104 | | * In HotTextInterval class add new function: public HotTextInterval unite(HotTextInterval interval) - |
| 105 | | Unites two intervals - gets the largest possible interval from the given one and the current. |
| 106 | | * In ImmTextUtils add new function: public static ImmText concat(ImmText text1, ImmText text2) - |
| 107 | | Concatenates the two given texts. Keeps the styles as the origin texts. |
| 108 | | * Rename TextViewFlow to TextModel and add new functions as follows: |
| 109 | | * public abstract ImmText getRawText() - The text in the model. This is text without any attributes added for highlights, selection, etc. |
| 110 | | * public abstract ImmText getProcessedText() - The text that the layout use. This text differs from |
| 111 | | the raw text only by some text attributes (added for highlights, selection etc.) |
| | 59 | * '''public abstract ImmText applyTo(ImmText sourceText)''' - This method applies the current text change to a given text and returns new text with applied change. |
| | 60 | * '''public abstract HotTextInterval getSourceDamage(ImmText sourceText)''' - Returns the damaged region (interval) from the source text. |
| | 61 | * '''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. |
| | 62 | * '''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. |
| | 63 | * 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. |
| | 64 | * 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. |
| | 65 | * 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. |
| | 66 | * In '''CommonAttr''' class add new ''public static final HotAttr<Boolean> DUMMY_ATTRIBUTE'' - Attribute that is true only if the char is EMPTY_CHAR.This is needed because the last text run in the text layout has to consist only of the ''EMPTY_CHAR'' in order not to be drawn and not to be handled in complicated ways. |
| | 67 | * In '''ImmTextUtils''' class add new method: ''public static ImmText createDefaultText()'' - Creates a text with one char equal to ''EMPTY_CHAR''. |
| | 68 | * 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. |
| | 69 | * In '''LayoutAttr''' class add ''HotAttr<Boolean> CARET_ATTR'' - this attribute represents the caret in the view. True if the caret is before that char. |
| | 70 | * In '''CommonChar''' class add static final char ''EMPTY_CHAR'' - A dummy char inserted at the end of a text to help the text navigation. Used only in the layout. |
| | 71 | * 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. |
| | 72 | * 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. |
| | 73 | * Rename '''TextViewFlow''' to '''TextModel''' and add new functions as follows: |
| | 74 | * '''public abstract ImmText getRawText()''' - The text in the model. This is text without any attributes added for highlights, selection, etc. |
| | 75 | * '''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.) |
| 113 | | * In org.sophie2.base.model.text.mvc package add new class abstract class BaseTextModel extends TextModel - |
| 114 | | Basic implementation of the methods from the TextModel abstract class. This class has function public void |
| 115 | | update(TextChange change) that applies the given change to the raw text and to the processed text and |
| 116 | | updates the indexes of the caret an the mark of the model. |
| 117 | | * In org.sophie2.base.model.text.mvc package add new class public static class SelectionOptions<T> implements |
| 118 | | TextProcessor.Options - a class representing the options of the selection processor. This class has private final HotAttr<T> attribute, |
| 119 | | private final T value, private final HotTextInterval selectionInterval. The first one holds the attribute of |
| 120 | | the selection (CommonAttr.BACKGROUND_COLOR), the second one holds it's value (Ex: ImmColor.Blue) and |
| 121 | | the third one holds the selection interval. |
| 122 | | * In org.sophie2.base.model.text.mvc package add new class SelectionProcessor implements TextProcessor<SelectionOptions, |
| 123 | | DefaultTextEffect> - Processes text selection and caret.Its work consists of modifying some of the the color attributes for |
| 124 | | the selected chars, as well as to put a LayoutAttr#CARET_ATTR somewhere. |
| 125 | | * In org.sophie2.base.model.text.mvc.swing package add new class: SwingTextModel extends BaseTextModel - |
| 126 | | The swing realization of the {@link TextModel} class. It is used only for testing. |
| 127 | | * In org.sophie2.main.func.text.view package add new class : abstract class TextResourceModel extends |
| 128 | | BaseTextModel - Base implementation of the TextModel that connects the view with the text resource. It has |
| 129 | | one function: public void changeModel(final TextChange change, ResourceAccess access, |
| 130 | | final ImmText text, boolean significant, String description) - Method for updating the text model with a given TextChange. |
| 131 | | Changes the text resource, related to the view that holds the current TextResourceModel and updates the caret and mark poses |
| 132 | | to stay consistent. |
| 133 | | * Make the class HeadTextModel extend TextResourceModel. |
| 134 | | * In HotTextLogic class rename ON_SET_TEXT to ON_CHANGE_TEXT and call the changeModel when the text needs to |
| 135 | | be changed in the model(replace the AutoAction part). |
| | 77 | * 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. |
| | 78 | * 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. |
| | 79 | * 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. |
| | 80 | * 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. |
| | 81 | * 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, |
| | 82 | 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. |
| | 83 | * Make the class '''HeadTextModel''' extend TextResourceModel. |
| | 84 | * 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). |
