/*
* [HTMLCommentTag.java]
*
* Summary: Describes HTML comment start and end markers not counting contents [-- --].
*
* Copyright: (c) 2004-2017 Roedy Green, Canadian Mind Products, http://mindprod.com
*
* Licence: This software may be copied and used freely for any purpose but military.
* http://mindprod.com/contact/nonmil.html
*
* Requires: JDK 1.8+
*
* Created with: JetBrains IntelliJ IDEA IDE http://www.jetbrains.com/idea/
*
* Version History:
* 2.0 2009-04-19 tidy comments, more accurate colour names
*/
package com.mindprod.jtokens.html;
import com.mindprod.jtokens.Comment;
import java.awt.Color;
import java.awt.Font;
import static com.mindprod.jtokens.TokenColourScheme.HTML_FOREGROUND_FOR_COMMENT_TAG;
import static com.mindprod.jtokens.TokenFonts.MONO_FONTS;
import static com.mindprod.jtokens.TokenFonts.NORMAL_FONT_SIZE_IN_POINTS;
/**
* Describes HTML comment start and end markers not counting contents [-- --].
*
* @author Roedy Green, Canadian Mind Products
* @version 2.0 2009-04-19 tidy comments, more accurate colour names
* @since 2004-04-24
*/
public final class HTMLCommentTag extends Comment
{
/**
* version number for the class
*/
static final long serialVersionUID = 3L;
/**
* Font to render this token
*/
@SuppressWarnings( { "ConstantNamingConvention" } )
private static final Font htmlCommentTagFont =
bestFont( MONO_FONTS, Font.ITALIC, NORMAL_FONT_SIZE_IN_POINTS - 1 );
/**
* Constructor
*
* @param comment text including <-- and --> delimiters and but no embedded \n
*/
public HTMLCommentTag( String comment )
{
super( comment );
}
/**
* font to render this token.
*
* @return Font, in the correct size.
*/
public Font getFont()
{
return htmlCommentTagFont;
}
/**
* foreground colour to render this token.
*
* @return Color object.
*/
public Color getForeground()
{
return HTML_FOREGROUND_FOR_COMMENT_TAG;
}
/**
* get the text surrounded by CSS html
*
* @return decorated HTML in a " + getRawHTML() + "";
}
}