added class diagram to README.md
This commit is contained in:
1 parent
92f249ce75
commit
5aa6bf5df0
2 files changed
+16
-8
No files matched your search
@@ -1,7 +1,7 @@
|
|||||||
#Texteditor
|
#Texteditor
|
||||||
Texteditor is a program to edit a text by using the input and is then able to output it as desired via the console.
|
Texteditor is a program to edit a text by using the input and is then able to output it as desired via the console.
|
||||||
#Usermanual
|
##Usermanual
|
||||||
#ADD a paragraph
|
###ADD a paragraph
|
||||||
```ADD```
|
```ADD```
|
||||||
Adds a paragraph with custom text.<br/> <br/>
|
Adds a paragraph with custom text.<br/> <br/>
|
||||||
Enter the command add to add a new paragraph at the end of text. After submitting the add command you will be prompted to enter the text to add as last paragraph.
|
Enter the command add to add a new paragraph at the end of text. After submitting the add command you will be prompted to enter the text to add as last paragraph.
|
||||||
@@ -11,7 +11,7 @@ Adds a paragraph with custom text at a specific position in text.<br/> <br/>
|
|||||||
Enter the command add with the paragraph number where it should be added.
|
Enter the command add with the paragraph number where it should be added.
|
||||||
After submitting the add [n] command you will be prompted to enter the text to add in the corresponding paragraph.
|
After submitting the add [n] command you will be prompted to enter the text to add in the corresponding paragraph.
|
||||||
|
|
||||||
#DUMMY Text
|
###DUMMY Text
|
||||||
```DUMMY```
|
```DUMMY```
|
||||||
Inserts a paragraph with dummy text at the end of the text.<br/> <br/>
|
Inserts a paragraph with dummy text at the end of the text.<br/> <br/>
|
||||||
Enter the command dummy to enter a pre-written paragraph into the text as your last paragraph.
|
Enter the command dummy to enter a pre-written paragraph into the text as your last paragraph.
|
||||||
@@ -20,7 +20,7 @@ Enter the command dummy to enter a pre-written paragraph into the text as your l
|
|||||||
Inserts a paragraph with dummy text at a specific position.<br/> <br/>
|
Inserts a paragraph with dummy text at a specific position.<br/> <br/>
|
||||||
Enter the command dummy with a paragraph number to insert a pre-written dummy text paragraph to a spcific position.
|
Enter the command dummy with a paragraph number to insert a pre-written dummy text paragraph to a spcific position.
|
||||||
|
|
||||||
#REPLACE a Text
|
###REPLACE a Text
|
||||||
```REPLACE```
|
```REPLACE```
|
||||||
Replaces desired words in the last paragraph with a desired replacement.<br/> <br/>
|
Replaces desired words in the last paragraph with a desired replacement.<br/> <br/>
|
||||||
Enter the command replace, after submitting the command replace enter the characters that should be replaced. After submitting the characters you will be
|
Enter the command replace, after submitting the command replace enter the characters that should be replaced. After submitting the characters you will be
|
||||||
@@ -32,7 +32,7 @@ Enter the command replace with a desired paragraph where the characters should b
|
|||||||
after submitting the command replace enter the characters that should be replaced. After submitting the characters you will be
|
after submitting the command replace enter the characters that should be replaced. After submitting the characters you will be
|
||||||
need to input the characters wich will replace the previous characters.
|
need to input the characters wich will replace the previous characters.
|
||||||
|
|
||||||
#DELETE a Text
|
###DELETE a Text
|
||||||
```DEL```
|
```DEL```
|
||||||
Deletes the last paragraph.<br/> <br/>
|
Deletes the last paragraph.<br/> <br/>
|
||||||
Enter the command del to delete the last paragraph.
|
Enter the command del to delete the last paragraph.
|
||||||
@@ -41,18 +41,18 @@ Enter the command del to delete the last paragraph.
|
|||||||
Deletes the selected paragraph.<br/> <br/>
|
Deletes the selected paragraph.<br/> <br/>
|
||||||
Enter the command del with a paragraph number, the corresponding paragraph will then be deleted.
|
Enter the command del with a paragraph number, the corresponding paragraph will then be deleted.
|
||||||
|
|
||||||
#INDEX the words
|
###INDEX the words
|
||||||
```INDEX```
|
```INDEX```
|
||||||
Diplays the index of words used 3 times or more.<br/> <br/>
|
Diplays the index of words used 3 times or more.<br/> <br/>
|
||||||
Enter the command index to display the words that are displayed more than three times in the text with their corresponding paragraphs.
|
Enter the command index to display the words that are displayed more than three times in the text with their corresponding paragraphs.
|
||||||
|
|
||||||
#Print the Text
|
###Print the Text
|
||||||
```PRINT```
|
```PRINT```
|
||||||
Prints the text with the previously set format option.<br/> <br/>
|
Prints the text with the previously set format option.<br/> <br/>
|
||||||
Enter the command print to print out the current text you have. The Text will be printed with the settings set before (see FORMAT the Text).
|
Enter the command print to print out the current text you have. The Text will be printed with the settings set before (see FORMAT the Text).
|
||||||
If no settings have been set the standard to output is the FIX format and a line length of 20.
|
If no settings have been set the standard to output is the FIX format and a line length of 20.
|
||||||
|
|
||||||
#FORMAT the Text
|
###FORMAT the Text
|
||||||
```FORMAT RAW```
|
```FORMAT RAW```
|
||||||
Sets the format to raw.<br/> <br/>
|
Sets the format to raw.<br/> <br/>
|
||||||
Enter the command format raw to change the print format to raw. After you changed the format to raw you can use the command ```PRINT``` again
|
Enter the command format raw to change the print format to raw. After you changed the format to raw you can use the command ```PRINT``` again
|
||||||
@@ -64,3 +64,10 @@ Enter the command format fix and the max line length which will be used. After y
|
|||||||
and the text will be displayed with the max length in mind and a new line will be created if no space is left for a paragraph.
|
and the text will be displayed with the max length in mind and a new line will be created if no space is left for a paragraph.
|
||||||
If a word is too long to fit the line length, it will be displayed as whole, ignoring the max length.
|
If a word is too long to fit the line length, it will be displayed as whole, ignoring the max length.
|
||||||
|
|
||||||
|
|
||||||
|
##Classdiagramm
|
||||||
|
|
||||||
|
<div class="mxgraph" style="max-width:100%;border:1px solid transparent;" data-mxgraph="{"highlight":"#0000ff","nav":true,"resize":true,"toolbar":"zoom layers lightbox","edit":"_blank","xml":"<mxfile host=\"drawio-plugin\" modified=\"2021-11-12T16:51:33.181Z\" agent=\"5.0 (Windows NT 6.2; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/89.0.4389.114 Safari/537.36\" etag=\"UV4OUhXHOZGBUB76x4mF\" version=\"14.7.4\" type=\"embed\"><diagram id=\"eWy9IwHxbh3JgAdMnOEg\" name=\"Seite-1\"><mxGraphModel dx=\"2606\" dy=\"774\" grid=\"1\" gridSize=\"10\" guides=\"1\" tooltips=\"1\" connect=\"1\" arrows=\"1\" fold=\"1\" page=\"1\" pageScale=\"1\" pageWidth=\"827\" pageHeight=\"1169\" math=\"0\" shadow=\"0\"><root><mxCell id=\"0\"/><mxCell id=\"1\" parent=\"0\"/><mxCell id=\"9L6EbMpzsWciNYXeLQUw-5\" value=\"TextEditor\" style=\"swimlane;fontStyle=1;align=center;verticalAlign=top;childLayout=stackLayout;horizontal=1;startSize=26;horizontalStack=0;resizeParent=1;resizeParentMax=0;resizeLast=0;collapsible=1;marginBottom=0;\" parent=\"1\" vertex=\"1\"><mxGeometry x=\"50\" y=\"350\" width=\"220\" height=\"60\" as=\"geometry\"/></mxCell><mxCell id=\"9L6EbMpzsWciNYXeLQUw-7\" value=\"\" style=\"line;strokeWidth=1;fillColor=none;align=left;verticalAlign=middle;spacingTop=-1;spacingLeft=3;spacingRight=3;rotatable=0;labelPosition=right;points=[];portConstraint=eastwest;\" parent=\"9L6EbMpzsWciNYXeLQUw-5\" vertex=\"1\"><mxGeometry y=\"26\" width=\"220\" height=\"8\" as=\"geometry\"/></mxCell><mxCell id=\"9L6EbMpzsWciNYXeLQUw-8\" value=\"private static void Main(String[] args)\" style=\"text;strokeColor=none;fillColor=none;align=left;verticalAlign=top;spacingLeft=4;spacingRight=4;overflow=hidden;rotatable=0;points=[[0,0.5],[1,0.5]];portConstraint=eastwest;\" parent=\"9L6EbMpzsWciNYXeLQUw-5\" vertex=\"1\"><mxGeometry y=\"34\" width=\"220\" height=\"26\" as=\"geometry\"/></mxCell><mxCell id=\"9L6EbMpzsWciNYXeLQUw-12\" value=\"Text\" style=\"swimlane;fontStyle=1;align=center;verticalAlign=top;childLayout=stackLayout;horizontal=1;startSize=26;horizontalStack=0;resizeParent=1;resizeParentMax=0;resizeLast=0;collapsible=1;marginBottom=0;\" parent=\"1\" vertex=\"1\"><mxGeometry x=\"690\" y=\"210\" width=\"310\" height=\"198\" as=\"geometry\"/></mxCell><mxCell id=\"3\" value=\"- text:ArrayList&lt;String&gt;{final}\" style=\"text;strokeColor=none;fillColor=none;align=left;verticalAlign=top;spacingLeft=4;spacingRight=4;overflow=hidden;rotatable=0;points=[[0,0.5],[1,0.5]];portConstraint=eastwest;fontStyle=0\" parent=\"9L6EbMpzsWciNYXeLQUw-12\" vertex=\"1\"><mxGeometry y=\"26\" width=\"310\" height=\"20\" as=\"geometry\"/></mxCell><mxCell id=\"2\" value=\"- dummyText{final}\" style=\"text;strokeColor=none;fillColor=none;align=left;verticalAlign=top;spacingLeft=4;spacingRight=4;overflow=hidden;rotatable=0;points=[[0,0.5],[1,0.5]];portConstraint=eastwest;fontStyle=4\" parent=\"9L6EbMpzsWciNYXeLQUw-12\" vertex=\"1\"><mxGeometry y=\"46\" width=\"310\" height=\"20\" as=\"geometry\"/></mxCell><mxCell id=\"9L6EbMpzsWciNYXeLQUw-14\" value=\"\" style=\"line;strokeWidth=1;fillColor=none;align=left;verticalAlign=middle;spacingTop=-1;spacingLeft=3;spacingRight=3;rotatable=0;labelPosition=right;points=[];portConstraint=eastwest;\" parent=\"9L6EbMpzsWciNYXeLQUw-12\" vertex=\"1\"><mxGeometry y=\"66\" width=\"310\" height=\"8\" as=\"geometry\"/></mxCell><mxCell id=\"9L6EbMpzsWciNYXeLQUw-15\" value=\"+ add(int:n, String):boolean&#10;+ dummy(int:n):boolean&#10;+ replace(int:n, String, String):boolean&#10;+ index():ArrayList&lt;String&gt;&#10;+ getText():ArrayList&lt;String&gt;&#10;+ del(int:n):boolean&#10;- createWordlist(HashMap&lt;String, ArrayList&lt;Integer&gt;&gt;)&#10;- paragraphExists(int):boolean\" style=\"Line truncated
|
||||||
|
<script type="text/javascript" src="https://viewer.diagrams.net/js/viewer-static.min.js"></script>
|
||||||
|
|
||||||
|

|
||||||
@@ -0,0 +1 @@
|
|||||||
|
<mxfile host="drawio-plugin" modified="2021-11-12T09:27:12.653Z" agent="5.0 (Windows NT 6.2; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/89.0.4389.114 Safari/537.36" etag="uaH2AUDgSYhApJfWl2lm" version="14.7.4" type="embed"><diagram id="eWy9IwHxbh3JgAdMnOEg" name="Seite-1"><mxGraphModel dx="484" dy="177" grid="1" gridSize="10" guides="1" tooltips="1" connect="1" arrows="1" fold="1" page="1" pageScale="1" pageWidth="827" pageHeight="1169" math="0" shadow="0"><root><mxCell id="0"/><mxCell id="1" parent="0"/><mxCell id="9L6EbMpzsWciNYXeLQUw-5" value="TextEditor" style="swimlane;fontStyle=1;align=center;verticalAlign=top;childLayout=stackLayout;horizontal=1;startSize=26;horizontalStack=0;resizeParent=1;resizeParentMax=0;resizeLast=0;collapsible=1;marginBottom=0;" parent="1" vertex="1"><mxGeometry x="50" y="350" width="220" height="60" as="geometry"/></mxCell><mxCell id="9L6EbMpzsWciNYXeLQUw-7" value="" style="line;strokeWidth=1;fillColor=none;align=left;verticalAlign=middle;spacingTop=-1;spacingLeft=3;spacingRight=3;rotatable=0;labelPosition=right;points=[];portConstraint=eastwest;" parent="9L6EbMpzsWciNYXeLQUw-5" vertex="1"><mxGeometry y="26" width="220" height="8" as="geometry"/></mxCell><mxCell id="9L6EbMpzsWciNYXeLQUw-8" value="private static void Main(String[] args)" style="text;strokeColor=none;fillColor=none;align=left;verticalAlign=top;spacingLeft=4;spacingRight=4;overflow=hidden;rotatable=0;points=[[0,0.5],[1,0.5]];portConstraint=eastwest;" parent="9L6EbMpzsWciNYXeLQUw-5" vertex="1"><mxGeometry y="34" width="220" height="26" as="geometry"/></mxCell><mxCell id="9L6EbMpzsWciNYXeLQUw-12" value="Text" style="swimlane;fontStyle=1;align=center;verticalAlign=top;childLayout=stackLayout;horizontal=1;startSize=26;horizontalStack=0;resizeParent=1;resizeParentMax=0;resizeLast=0;collapsible=1;marginBottom=0;" parent="1" vertex="1"><mxGeometry x="690" y="210" width="310" height="198" as="geometry"/></mxCell><mxCell id="3" value="- text:ArrayList<String>{final}" style="text;strokeColor=none;fillColor=none;align=left;verticalAlign=top;spacingLeft=4;spacingRight=4;overflow=hidden;rotatable=0;points=[[0,0.5],[1,0.5]];portConstraint=eastwest;fontStyle=0" parent="9L6EbMpzsWciNYXeLQUw-12" vertex="1"><mxGeometry y="26" width="310" height="20" as="geometry"/></mxCell><mxCell id="2" value="- dummyText{final}" style="text;strokeColor=none;fillColor=none;align=left;verticalAlign=top;spacingLeft=4;spacingRight=4;overflow=hidden;rotatable=0;points=[[0,0.5],[1,0.5]];portConstraint=eastwest;fontStyle=4" parent="9L6EbMpzsWciNYXeLQUw-12" vertex="1"><mxGeometry y="46" width="310" height="20" as="geometry"/></mxCell><mxCell id="9L6EbMpzsWciNYXeLQUw-14" value="" style="line;strokeWidth=1;fillColor=none;align=left;verticalAlign=middle;spacingTop=-1;spacingLeft=3;spacingRight=3;rotatable=0;labelPosition=right;points=[];portConstraint=eastwest;" parent="9L6EbMpzsWciNYXeLQUw-12" vertex="1"><mxGeometry y="66" width="310" height="8" as="geometry"/></mxCell><mxCell id="9L6EbMpzsWciNYXeLQUw-15" value="+ add(int:n, String):boolean + dummy(int:n):boolean + replace(int:n, String, String):boolean + index():ArrayList<String> + getText():ArrayList<String> + del(int:n):boolean - createWordlist(HashMap<String, ArrayList<Integer>>) - paragraphExists(int):boolean" style="text;strokeColor=none;fillColor=none;align=left;verticalAlign=top;spacingLeft=4;spacingRight=4;overflow=hidden;rotatable=0;points=[[0,0.5],[1,0.5]];portConstraint=eastwest;shadow=0;" parent="9L6EbMpzsWciNYXeLQUw-12" vertex="1"><mxGeometry y="74" width="310" height="124" as="geometry"/></mxCell><mxCell id="9L6EbMpzsWciNYXeLQUw-16" value="TextLogic" style="swimlane;fontStyle=1;align=center;verticalAlign=top;childLayout=stackLayout;horizontal=1;startSize=26;horizontalStack=0;resizeParent=1;resizeParentMax=0;resizeLast=0;collapsible=1;marginBottom=0;" parent="1" vertex="1"><mxGeometry x="380" y="347" width="170" height="114" as="geometry"/></mxCell><mxCell id="9L6EbMpzsWciNYXeLQUw-17" value="- text Text{final} - textOutput Textoutput{final}" style="text;strokeColor=none;fillColor=none;align=left;verticalAlign=top;spacingLeft=4;spacingRight=4;overflow=hidden;rotatable=0;points=[[0,0.5],[1,0.5]];portConstraint=eastwest;" parent="9L6EbMpzsWciNYXeLQUw-16" vertex="1"><mxGeometry y="26" width="170" height="30" as="geometry"/></mxCell><mxCell id="9L6EbMpzsWciNYXeLQUw-18" value="" style="line;strokeWidth=1;fillColor=none;align=left;verticalAlign=middle;spacingTop=-1;spacingLeft=3;spacingRight=3;rotatable=0;labelPosition=right;points=[];portConstraint=eastwest;" parent="9L6EbMpzsWciNYXeLQUw-16" vertex="1"><mxGeometry y="56" width="170" height="8" as="geometry"/></mxCell><mxCell id="9L6EbMpzsWciNYXeLQUw-19" value="+ TextLogik - isNumeric(String):boolean - checkIfSuccess(boolean)" style="text;strokeColor=none;fillColor=none;align=left;verticalAlign=top;spacingLeft=4;spacingRight=4;overflow=hidden;rotatable=0;points=[[Line truncated
|
||||||
Reference in new issue
Block a user