com.alee.extended.label.StyledTextRow Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of weblaf-ui Show documentation
WebLaF UI components
The newest version!
/*
 * This file is part of WebLookAndFeel library.
 *
 * WebLookAndFeel library is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * WebLookAndFeel library is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with WebLookAndFeel library.  If not, see .
 */

package com.alee.extended.label;

import com.alee.utils.TextUtils;

import java.awt.*;
import java.util.ArrayList;
import java.util.List;

/**
 * Styled text row data.
 *
 * @author Alexandr Zernov
 * @see How to use WebStyledLabel
 */
public class StyledTextRow
{
    /**
     * List of styled text fragments.
     */
    public List fragments;

    /**
     * Whether the row is leading (first in text or after hard break) or not.
     */
    public boolean leading;

    /**
     * Row width.
     */
    public int width;

    /**
     * Row height.
     */
    public int height;

    /**
     * Mnemonic index.
     */
    public int mnemonic;

    /**
     * Constructs row with the specified height.
     *
     * @param height  row height
     * @param leading whether the row is leading (first in text or after hard break) or not
     */
    public StyledTextRow ( final int height, final boolean leading )
    {
        this.fragments = new ArrayList ();
        this.leading = leading;
        this.width = 0;
        this.height = height;
        this.mnemonic = -1;
    }

    /**
     * Appends the row.
     *
     * @param s             text fragment
     * @param style         fragment style
     * @param fm            font metrics
     * @param charOffset    fragment total offset in chars
     * @param mnemonicIndex mnemonic index
     * @return width of appended fragment
     */
    public int append ( final String s, final StyleRange style, final FontMetrics fm, final int charOffset, final int mnemonicIndex )
    {
        int sWidth = 0;
        if ( mnemonicIndex >= 0 && s.length () > mnemonicIndex - charOffset )
        {
            mnemonic = mnemonicIndex - charOffset;
            for ( final TextRange fragment : fragments )
            {
                mnemonic += fragment.text.length ();
            }
        }
        if ( fragments.isEmpty () && !leading )
        {
            // Trimming left first fragment
            final int fw = TextUtils.findFirstWordFromIndex ( s, 0 );
            if ( fw >= 0 )
            {
                final String trimmed = s.substring ( fw, s.length () );
                fragments.add ( new TextRange ( trimmed, style ) );
                if ( mnemonic > 0 )
                {
                    mnemonic -= fw;
                }
                sWidth += fm.stringWidth ( trimmed );
            }
            else
            {
                if ( mnemonic > 0 )
                {
                    mnemonic -= s.length ();
                }
                fragments.add ( new TextRange ( "", style ) );
            }
        }
        else
        {
            fragments.add ( new TextRange ( s, style ) );
            sWidth += fm.stringWidth ( s );
        }
        width += sWidth;
        return sWidth;
    }

    /**
     * Returns whether the row is empty or not.
     *
     * @return true if  the row is empty, false otherwise
     */
    public boolean isEmpty ()
    {
        return fragments.isEmpty ();
    }
}