001/* ===========================================================
002 * JFreeChart : a free chart library for the Java(tm) platform
003 * ===========================================================
004 *
005 * (C) Copyright 2000-2020, by Object Refinery Limited and Contributors.
006 *
007 * Project Info:  http://www.jfree.org/jfreechart/index.html
008 *
009 * This library is free software; you can redistribute it and/or modify it
010 * under the terms of the GNU Lesser General Public License as published by
011 * the Free Software Foundation; either version 2.1 of the License, or
012 * (at your option) any later version.
013 *
014 * This library is distributed in the hope that it will be useful, but
015 * WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
016 * or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public
017 * License for more details.
018 *
019 * You should have received a copy of the GNU Lesser General Public
020 * License along with this library; if not, write to the Free Software
021 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301,
022 * USA.
023 *
024 * [Oracle and Java are registered trademarks of Oracle and/or its affiliates. 
025 * Other names may be trademarks of their respective owners.]
026 *
027 * ------------
028 * LogTick.java
029 * ------------
030 * (C) Copyright 2014, by Object Refinery Limited and Contributors.
031 *
032 * Original Author:  David Gilbert (for Object Refinery Limited);
033 * Contributor(s):   -;
034 *
035 * Changes
036 * -------
037 * 18-Mar-2014 : Version 1 (DG);
038 * 
039 */
040
041package org.jfree.chart.axis;
042
043import java.text.AttributedString;
044import org.jfree.chart.ui.TextAnchor;
045
046/**
047 * A tick from a {@link LogAxis}.
048 */
049public class LogTick extends ValueTick {
050    
051    /** The attributed string for the tick label. */
052    AttributedString attributedLabel;
053    
054    /**
055     * Creates a new instance.
056     * 
057     * @param type  the type (major or minor tick, {@code null} not 
058     *         permitted).
059     * @param value  the value.
060     * @param label  the label ({@code null} permitted).
061     * @param textAnchor  the text anchor.
062     */
063    public LogTick(TickType type, double value, AttributedString label, 
064            TextAnchor textAnchor) {
065        super(type, value, null, textAnchor, textAnchor, 0.0);
066        this.attributedLabel = label;
067    }
068    
069    /**
070     * Returns the attributed string for the tick label, or {@code null} 
071     * if there is no label.
072     * 
073     * @return The attributed string or {@code null}. 
074     */
075    public AttributedString getAttributedLabel() {
076        return this.attributedLabel;
077    }
078}