001    // This file is part of AceWiki.
002    // Copyright 2008-2012, AceWiki developers.
003    // 
004    // AceWiki is free software: you can redistribute it and/or modify it under the terms of the GNU
005    // Lesser General Public License as published by the Free Software Foundation, either version 3 of
006    // the License, or (at your option) any later version.
007    // 
008    // AceWiki is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without
009    // even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
010    // Lesser General Public License for more details.
011    // 
012    // You should have received a copy of the GNU Lesser General Public License along with AceWiki. If
013    // not, see http://www.gnu.org/licenses/.
014    
015    package ch.uzh.ifi.attempto.acewiki.core;
016    
017    /**
018     * This class represents a detail of a sentence like a syntax tree or a logical formula.
019     * 
020     * @author Tobias Kuhn
021     */
022    public class SentenceDetail {
023            
024            private final String name;
025            private final String richText;
026            
027            /**
028             * Creates a new sentence detail.
029             * 
030             * @param name The name of the detail, as shown to the user.
031             * @param richText The content of the detail, possibly containing HTML tags.
032             */
033            public SentenceDetail(String name, String richText) {
034                    this.name = name;
035                    this.richText = richText;
036            }
037            
038            /**
039             * Returns the name of the sentence detail, as shown to the user.
040             * 
041             * @return The name.
042             */
043            public String getName() {
044                    return name;
045            }
046            
047            /**
048             * Returns the content of the sentence detail. It can be plain text or contain HTML tags.
049             * 
050             * @return The content as rich text.
051             */
052            public String getRichText() {
053                    return richText;
054            }
055    
056    }