Source code

001/*
002 * Copyright (c) 2010, 2013, Oracle and/or its affiliates. All rights reserved.
003 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
004 *
005 * This code is free software; you can redistribute it and/or modify it
006 * under the terms of the GNU General Public License version 2 only, as
007 * published by the Free Software Foundation.  Oracle designates this
008 * particular file as subject to the "Classpath" exception as provided
009 * by Oracle in the LICENSE file that accompanied this code.
010 *
011 * This code is distributed in the hope that it will be useful, but WITHOUT
012 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
013 * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
014 * version 2 for more details (a copy is included in the LICENSE file that
015 * accompanied this code).
016 *
017 * You should have received a copy of the GNU General Public License version
018 * 2 along with this work; if not, write to the Free Software Foundation,
019 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
020 *
021 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
022 * or visit www.oracle.com if you need additional information or have any
023 * questions.
024 */
025
026package javafx.scene.control;
027
028/**
029 * Defines the behavior of a labeled Control when the space for rendering the
030 * text is smaller than the space needed to render the entire string.
031 */
032public enum OverrunStyle {
033    /**
034     * Any text which exceeds the bounds of the label will be clipped.
035     */
036    CLIP,
037    /**
038     * If the text of the label exceeds the bounds of the label, then the last
039     * three characters which can be displayed will be "...". If the label is
040     * too short to even display that, then only as many "." as possible will
041     * be shown.
042     */
043    ELLIPSIS,
044    /**
045     * Same as ELLIPSIS, but first removes any partial words at the label
046     * boundary and then applies the ellipsis. This ensures that the last
047     * characters displayed prior to the ellipsis are part of a full word.
048     * Where a full word cannot be displayed, this acts like ELLIPSIS and
049     * displays as many characters as possible.
050     */
051    WORD_ELLIPSIS,
052    /**
053     * Trims out the center of the string being displayed and replaces the
054     * middle three characters with "...". The first and last characters of
055     * the string are always displayed in the label, unless the label becomes
056     * so short that it cannot display anything other than the ellipsis.
057     */
058    CENTER_ELLIPSIS,
059    /**
060     * Same as CENTER_ELLIPSIS but ensures that the "..." occurs between full
061     * words. If the label becomes so short that it is not possible to trim
062     * any additional words, then partial words are displayed and this behaves
063     * the same as CENTER_ELLIPSIS
064     */
065    CENTER_WORD_ELLIPSIS,
066    /**
067     * Same as ELLIPSIS but puts the "..." at the beginning of the text instead
068     * of at the end
069     */
070    LEADING_ELLIPSIS,
071    /**
072     * Same as WORD_ELLIPSIS but puts the "..." at the beginning of the text
073     * instead of at the end
074     */
075    LEADING_WORD_ELLIPSIS
076    /**
077     * Indicates that the entire text should be available, but should scroll
078     * as if in a ticker tape
079     */
080    //TICKER
081}
082