/*
* Copyright (C) 2015 Koji Lin <koji.lin@gmail.com>
* Copyright (C) 2011 René Jeschke <rene_jeschke@yahoo.de>
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package io.kaif.mobile.kmark;
import android.text.SpannableStringBuilder;
/**
* Decorator interface.
*
* @author René Jeschke <rene_jeschke@yahoo.de>
*/
public interface Decorator {
/**
* Called when a paragraph is opened.
* <p>
* <p>
* Default implementation is:
* </p>
* <p>
* <pre>
* <code>out.append("<p>");</code>
* </pre>
*
* @param out
* The StringBuilder to write to.
*/
public void openParagraph(final SpannableStringBuilder out);
/**
* Called when a paragraph is closed.
* <p>
* <p>
* Default implementation is:
* </p>
* <p>
* <pre>
* <code>out.append("</p>\n");</code>
* </pre>
*
* @param out
* The StringBuilder to write to.
*/
public void closeParagraph(final SpannableStringBuilder out);
/**
* Called when a code block is opened.
* <p>
* <p>
* Default implementation is:
* </p>
* <p>
* <pre>
* <code>out.append("<pre><code>");</code>
* </pre>
*
* @param out
* The StringBuilder to write to.
*/
public void openCodeBlock(final SpannableStringBuilder out);
/**
* Called when a code block is closed.
* <p>
* <p>
* Default implementation is:
* </p>
* <p>
* <pre>
* <code>out.append("</code></pre>\n");</code>
* </pre>
*
* @param out
* The StringBuilder to write to.
*/
public void closeCodeBlock(final SpannableStringBuilder out);
/**
* Called when a code span is opened.
* <p>
* <p>
* Default implementation is:
* </p>
* <p>
* <pre>
* <code>out.append("<code>");</code>
* </pre>
*
* @param out
* The StringBuilder to write to.
*/
public void openCodeSpan(final SpannableStringBuilder out);
/**
* Called when a code span is closed.
* <p>
* <p>
* Default implementation is:
* </p>
* <p>
* <pre>
* <code>out.append("</code>");</code>
* </pre>
*
* @param out
* The StringBuilder to write to.
*/
public void closeCodeSpan(final SpannableStringBuilder out);
/**
* Called when a strong span is opened.
* <p>
* <p>
* Default implementation is:
* </p>
* <p>
* <pre>
* <code>out.append("<strong>");</code>
* </pre>
*
* @param out
* The StringBuilder to write to.
*/
public void openStrong(final SpannableStringBuilder out);
/**
* Called when a strong span is closed.
* <p>
* <p>
* Default implementation is:
* </p>
* <p>
* <pre>
* <code>out.append("</strong>");</code>
* </pre>
*
* @param out
* The StringBuilder to write to.
*/
public void closeStrong(final SpannableStringBuilder out);
/**
* Called when a strike span is opened.
* <p>
* <p>
* Default implementation is:
* </p>
* <p>
* <pre>
* <code>out.append("<s>");</code>
* </pre>
*
* @param out
* The StringBuilder to write to.
*/
public void openStrike(final SpannableStringBuilder out);
/**
* Called when a strike span is closed.
* <p>
* <p>
* Default implementation is:
* </p>
* <p>
* <pre>
* <code>out.append("</s>");</code>
* </pre>
*
* @param out
* The StringBuilder to write to.
*/
public void closeStrike(final SpannableStringBuilder out);
/**
* Called when an emphasis span is opened.
* <p>
* <p>
* Default implementation is:
* </p>
* <p>
* <pre>
* <code>out.append("<em>");</code>
* </pre>
*
* @param out
* The StringBuilder to write to.
*/
public void openEmphasis(final SpannableStringBuilder out);
/**
* Called when an emphasis span is closed.
* <p>
* <p>
* Default implementation is:
* </p>
* <p>
* <pre>
* <code>out.append("</em>");</code>
* </pre>
*
* @param out
* The StringBuilder to write to.
*/
public void closeEmphasis(final SpannableStringBuilder out);
/**
* Called when a superscript span is opened.
* <p>
* <p>
* Default implementation is:
* </p>
* <p>
* <pre>
* <code>out.append("<sup>");</code>
* </pre>
*
* @param out
* The StringBuilder to write to.
*/
public void openSuper(final SpannableStringBuilder out);
/**
* Called when a superscript span is closed.
* <p>
* <p>
* Default implementation is:
* </p>
* <p>
* <pre>
* <code>out.append("</sup>");</code>
* </pre>
*
* @param out
* The StringBuilder to write to.
*/
public void closeSuper(final SpannableStringBuilder out);
/**
* Called when an ordered list is opened.
* <p>
* <p>
* Default implementation is:
* </p>
* <p>
* <pre>
* <code>out.append("<ol>\n");</code>
* </pre>
*
* @param out
* The StringBuilder to write to.
*/
public void openOrderedList(final SpannableStringBuilder out);
/**
* Called when an ordered list is closed.
* <p>
* <p>
* Default implementation is:
* </p>
* <p>
* <pre>
* <code>out.append("</ol>\n");</code>
* </pre>
*
* @param out
* The StringBuilder to write to.
*/
public void closeOrderedList(final SpannableStringBuilder out);
/**
* Called when an unordered list is opened.
* <p>
* <p>
* Default implementation is:
* </p>
* <p>
* <pre>
* <code>out.append("<ul>\n");</code>
* </pre>
*
* @param out
* The StringBuilder to write to.
*/
public void openUnorderedList(final SpannableStringBuilder out);
/**
* Called when an unordered list is closed.
* <p>
* <p>
* Default implementation is:
* </p>
* <p>
* <pre>
* <code>out.append("</ul>\n");</code>
* </pre>
*
* @param out
* The StringBuilder to write to.
*/
public void closeUnorderedList(final SpannableStringBuilder out);
/**
* Called when a list item is opened.
* <p>
* <p>
* <strong>Note:</strong> Don't close the HTML tag!
* </p>
* <p>
* Default implementation is:
* </p>
* <p>
* <pre>
* <code>out.append("<li");</code>
* </pre>
*
* @param out
* The StringBuilder to write to.
*/
public void openOrderedListItem(final SpannableStringBuilder out);
public void openUnOrderedListItem(final SpannableStringBuilder out);
/**
* Called when a list item is closed.
* <p>
* <p>
* Default implementation is:
* </p>
* <p>
* <pre>
* <code>out.append("</li>\n");</code>
* </pre>
*
* @param out
* The StringBuilder to write to.
*/
public void closeOrderedListItem(final SpannableStringBuilder out);
public void closeUnOrderedListItem(final SpannableStringBuilder out);
/**
* Called when a link is opened.
* <p>
* <p>
* <strong>Note:</strong> Don't close the HTML tag!
* </p>
* <p>
* Default implementation is:
* </p>
* <p>
* <pre>
* <code>out.append("<a");</code>
* </pre>
*
* @param out
* The StringBuilder to write to.
*/
void openLink(final SpannableStringBuilder out);
void closeLink(final SpannableStringBuilder out, String url);
/**
* Called when a blockquote is opened.
* <p>
* Default implementation is:
* <p>
* <pre>
* <code>out.append("<blockquote>");</code>
* </pre>
*
* @param out
* The StringBuilder to write to.
*/
public void openBlockquote(final SpannableStringBuilder out);
/**
* Called when a blockquote is closed.
* <p>
* <p>
* Default implementation is:
* </p>
* <p>
* <pre>
* <code>out.append("</blockquote>\n");</code>
* </pre>
*
* @param out
* The StringBuilder to write to.
*/
public void closeBlockquote(final SpannableStringBuilder out);
}