Java Swing Border clipText(JComponent c, String val, int borderWidth)

Description

Clip a text.

License

Apache License

Parameter

Parameter	Description
c	the component used to clip the text. Width and FontMetrics from that component will be used for that purpose.
val	the text to clip.
borderWidth	width of the component border if any.

Return

a clipped text terminating with three dots if the text does not fit within the component. Otherwise, the text remains unchanged.

Declaration

public static String clipText(JComponent c, String val, int borderWidth) 

Method Source Code

//package com.java2s;
/* Copyright (C) 2003-2016 Patrick G. Durand
 *
 * 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.//  w  ww  . ja v  a2 s  .c  o  m
 */

import java.awt.Font;
import java.awt.FontMetrics;
import java.awt.Insets;

import javax.swing.JComponent;

public class Main {
    private static final String CLIPPING = "...";

    /**
     * Clip a text.
     * 
     * @param c the component used to clip the text. Width and FontMetrics from 
     * that component will be used for that purpose.
     * @param val the text to clip.
     * @param borderWidth width of the component border if any.
     * 
     * @return a clipped text terminating with three dots if the text does not
     * fit within the component. Otherwise, the text remains unchanged.
     */
    public static String clipText(JComponent c, String val, int borderWidth) {
        FontMetrics fm;
        String str;
        Insets insets;
        int i, size, width, totWidth;

        fm = c.getFontMetrics(c.getFont());
        insets = c.getInsets();
        width = c.getWidth() - (insets.left + insets.right) - 2 * borderWidth;
        totWidth = fm.stringWidth(CLIPPING) + 2 * borderWidth;
        size = val.length();
        for (i = 0; i < size; i++) {
            totWidth += fm.charWidth(val.charAt(i));
            if (totWidth > width) {
                break;
            }
        }
        if (i < size) {
            str = val.substring(0, i) + CLIPPING;
        } else {
            str = val;
        }
        return str;
    }

    /**
     * Clip a text.
     * 
     * @param fm the FontMetrics used to compute the clipped text.
     * @param val the text to clip.
     * @param width width of the component where the string will be displayed.
     * 
     * @return a clipped text terminating with three dots if the text does not
     * fit within the component. Otherwise, the text remains unchanged.
     */
    public static String clipText(FontMetrics fm, String val, int width) {
        String str;
        int i, size, totWidth;

        totWidth = fm.stringWidth(CLIPPING);
        size = val.length();
        for (i = 0; i < size; i++) {
            totWidth += fm.charWidth(val.charAt(i));
            if (totWidth > width) {
                break;
            }
        }
        if (i < size) {
            str = val.substring(0, i) + CLIPPING;
        } else {
            str = val;
        }
        return str;
    }

    /**
     * Clip a text.
     * 
     * @param c the component used to clip the text. Width from 
     * that component will be used for that purpose.
     * @param fnt the Font to use to evaluate whether or not the text fits within
     * the component. If null, Font is retrieved from the component.
     * @param val the text to clip.
     * @param xFrom starting x position within the component
     * @param xTo ending position within the component
     * 
     * @return a clipped text terminating with three dots if the text does not
     * fit within xFrom and xTo. Otherwise, the text remains unchanged.
     */
    public static String clipText(JComponent c, Font fnt, String val, int xFrom, int xTo) {
        FontMetrics fm;
        String str;
        int i, size, totWidth;

        fm = c.getFontMetrics(fnt != null ? fnt : c.getFont());
        totWidth = xFrom;
        size = val.length();
        for (i = 0; i < size; i++) {
            totWidth += fm.charWidth(val.charAt(i));
            if (totWidth > xTo) {
                break;
            }
        }
        if (i < size) {
            str = val.substring(0, i) + CLIPPING;
        } else {
            str = val;
        }
        return str;
    }
}

Related

1. addBorder(JComponent c, Border b)
2. addBorder(JComponent component, Border border)
3. addOuterBorder(JComponent c, Border out)
4. compareTabOrder(Component a, Component b)
5. copy(final Border border)
6. createCompoundBorder(Border... borders)
7. createDebugBorder(JComponent c, Color color)