DMDirc-Client/src/com/dmdirc/ui/messages/StyledMessageMaker.java

/*
 * Copyright (c) 2006-2015 DMDirc Developers
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy
 * of this software and associated documentation files (the "Software"), to deal
 * in the Software without restriction, including without limitation the rights
 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 * copies of the Software, and to permit persons to whom the Software is
 * furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in
 * all copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 * SOFTWARE.
 */

package com.dmdirc.ui.messages;

import com.dmdirc.util.colours.Colour;

/**
 * Interface for objects that a {@link Styliser} can use to create styled messages.
 */
public interface StyledMessageMaker<T> {

    /**
     * Produces the complete styled message.
     */
    T getStyledMessage();

    void resetAllStyles();

    void resetColours();

    void appendString(String text);

    void toggleBold();

    void toggleUnderline();

    void toggleItalic();

    void startHyperlink(String url);

    void endHyperlink();

    void toggleHyperlinkStyle(Colour colour);

    void startChannelLink(String channel);

    void endChannelLink();

    void toggleChannelLinkStyle(Colour colour);

    void startNicknameLink(String nickname);

    void endNicknameLink();

    void toggleFixedWidth();

    void setForeground(Colour colour);

    void setDefaultForeground(Colour colour);

    void setBackground(Colour colour);

    void setDefaultBackground(Colour colour);

    void startSmilie(String smilie);

    void endSmilie();

    void startToolTip(String tooltip);

    void endToolTip();

    void setDefaultFont(String fontName, int fontSize);

    int getMaximumFontSize();

    void clear();

}