source: other-projects/rsyntax-textarea/src/java/org/fife/ui/rsyntaxtextarea/modes/AbstractMarkupTokenMaker.java@ 25584

/*
 * 10/03/2009
 *
 * AbstractMarkupTokenMaker.java - Base class for token makers for markup
 * languages.
 * 
 * This library is distributed under a modified BSD license.  See the included
 * RSyntaxTextArea.License.txt file for details.
 */
package org.fife.ui.rsyntaxtextarea.modes;

import org.fife.ui.rsyntaxtextarea.AbstractJFlexTokenMaker;


/**
 * Base class for token makers for markup languages.
 *
 * @author Robert Futrell
 * @version 1.0
 */
public abstract class AbstractMarkupTokenMaker extends AbstractJFlexTokenMaker {


    /**
     * Returns whether markup close tags should be completed.
     *
     * @return Whether closing markup tags are to be completed.
     */
    public abstract boolean getCompleteCloseTags();


    /**
     * Returns the text to place at the beginning and end of a
     * line to "comment" it in a this programming language.
     *
     * @return The start and end strings to add to a line to "comment"
     *         it out.
     */
    public String[] getLineCommentStartAndEnd() {
        return new String[] { "<!--", "-->" };
    }


    /**
     * Overridden to return <code>true</code>.
     *
     * @return <code>true</code> always.
     */
    public final boolean isMarkupLanguage() {
        return true;
    }


}