/**
* Copyright 2010-2014 Jingjing Li.
*
* This file is part of jplot2d.
*
* jplot2d is free software: you can redistribute it and/or modify it
* under the terms of the GNU Lesser General Public License as
* published by the Free Software Foundation, either version 3 of the
* License, or any later version.
*
* jplot2d 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 Lesser Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public License
* along with jplot2d. If not, see
* The tick decision rules
*
* - if autoValues is false, the values can be set by {@link #setFixedTickValues(double[])}
* - if autoInterval is false, the interval can be set by {@link #setTickInterval(double)}
* - the interval is calculated according to tick number. If autoAdjustNumber is true, the number can be adjusted to
* derive better values.
*
*
* @author Jingjing Li
*
*/
@PropertyGroup("Axis Tick Manager")
public interface AxisTickManager extends Element {
public static final int DEFAULT_TICKS_NUMBER = 11;
@Hierarchy(HierarchyOp.GET)
public AxisTransform getAxisTransform();
@Hierarchy(HierarchyOp.JOIN)
public void setAxisTransform(AxisTransform rangeManager);
/**
* Returns all axes whose ticks are controlled by this tick manager.
*
* @return all axes whose ticks are controlled by this tick manager
*/
@Hierarchy(HierarchyOp.GETARRAY)
public Axis[] getAxes();
/**
* Returns the AxisTickTransform, which defines The relationship between user value and tick value.
*
* @return the AxisTickTransform.
*/
@Property(order = 0, styleable = false)
public AxisTickTransform getTickTransform();
/**
* Sets the AxisTickTransform, which defines The relationship between user value and tick value. The AuxTransform
* must be efficient immutable.
*
* @param transform
* the AxisTickTransform object.
*/
public void setTickTransform(AxisTickTransform transform);
/**
* Returns the tick range of this axis.
*
* @return the tick range of this axis.
*/
@Property(order = 1, styleable = false)
public Range getRange();
/**
* Set the tick range of the axis.
*
* @param range
* the new tick range of the axis
*/
public void setRange(Range range);
/**
* Returns true if tick values is auto calculated from interval, or false if tick values
* is assigned by {@link #setFixedTickValues(double[])}.
*
* @return true if tick values is auto calculated.
*/
@Property(order = 10, styleable = false)
public boolean isAutoTickValues();
/**
* Set to true to indicate the tick values need to be auto calculated or false to use user
* assigned values.
*
* @param atv
* the flag
*/
public void setAutoTickValues(boolean atv);
/**
* Return an array of number to representing the fixed tick positions set by {@link #setFixedTickValues(Object)}
*
* @return the labels of the ticks
*/
@Property(order = 11, styleable = false)
public Object getFixedTickValues();
/**
* Set an array of values that ticks will show. If the given values is null or a empty array, no tick will be drawn.
*
* The autoValues will be set to false when this method is called. The minor values will be cleared by this method.
*
* @param values
* the values in user unit where ticks are displayed.
*/
public void setFixedTickValues(Object values);
/**
* Return an array of double representing the fixed minor tick positions set by
* {@link #setFixedMinorTickValues(Object)}
*
* @return the labels of the ticks
*/
@Property(order = 12, styleable = false)
public Object getFixedMinorTickValues();
/**
* Set an array of double. If the given values is null or a empty array, no tick will be drawn.
*
* This method must be called after {@link #setFixedTickValues(double[])} is called.
* {@link #setFixedTickValues(double[])} calling will clear the minor values.
*
* @param values
* the values in user unit where minor ticks are displayed.
*/
public void setFixedMinorTickValues(Object minorValues);
/**
* Returns true if the tick interval is auto calculated from tick number and range, or false if the tick interval is
* assigned by {@link #setTickInterval(double)}
*
* @return if the tick number is auto calculated.
*/
@Property(order = 13, styleable = false)
public boolean isAutoTickInterval();
/**
* Set to true to indicate the tick interval need to be auto calculated, or false to
* disable auto-calculation and keep using the current interval.
*
* @param ati
* the flag
*/
public void setAutoTickInterval(boolean ati);
/**
* Return the interval in axis units between two ticks. For LOG axis, interval is the multiplying factor between two
* ticks.
*
* @return the interval between two ticks
*/
@Property(order = 14, styleable = false)
public double getTickInterval();
/**
* Set the interval in axis units between two ticks. It change the number of ticks displayed in the axis. For LOG
* axis, interval is the multiplying factor between two ticks.
*
* Setting a new interval will set autoInterval to false.
*
* @param interval
* the interval between two major ticks
* @see #setAutoTickInterval(Boolean)
*/
public void setTickInterval(double interval);
/**
* Return the offset of ticks.
*
* @return the offset.
*/
@Property(order = 15, styleable = false)
public double getTickOffset();
/**
* @param offset
* the offset of ticks
*/
public void setTickOffset(double offset);
/**
* Returns the proposed number of ticks. The actual number may be different from the given number, to get nice tick
* values.
*
* @return the number of ticks
*/
@Property(order = 16, styleable = false)
public int getTicks();
/**
* Set the proposed number of ticks in the axis. The actual number may be different from the given number, to get
* nice tick values. If the ticks may cause the tick interval close to precision limit, the actual ticks may be less
* than the given value without throw PrecisionException.
*
* @param tickNumber
* the number of ticks.
*/
public void setTicks(int tickNumber);
/**
* Returns true if the tick number is allowed to be automatically reduced to avoid tick label overlaps.
*
* @return if the tick number is auto calculated.
*/
@Property(order = 17, styleable = false)
public boolean isAutoAdjustTicks();
/**
* Set to true to allow the tick number to be automatically reduced to avoid tick label overlaps.
*
* @param flag
*/
public void setAutoAdjustTicks(boolean flag);
/**
* Returns true is the minor ticks number is derived from tick interval.
*
* @return true is the minor ticks number is derived from tick interval.
*/
@Property(order = 18, styleable = false)
public boolean isAutoMinorTicks();
/**
* When autoTickInterval is set to true:
*
* - if tick interval is 1, the minor interval is 0.2, create 4 minor ticks
* - if tick interval is 2, the minor interval is 0.5, create 3 minor ticks
* - if tick interval is 3, the minor interval is 1, create 2 minor ticks
* - if tick interval is 4, the minor interval is 1, create 3 minor ticks
* - if tick interval is 5, the minor interval is 1, create 4 minor ticks
* - if tick interval is 6, the minor interval is 2, create 2 minor ticks
* - if tick interval is 7, the minor interval is 1, create 6 minor ticks
* - if tick interval is 8, the minor interval is 2, create 3 minor ticks
* - if tick interval is 9, the minor interval is 3, create 2 minor ticks
* - if tick interval is not integer, create 0 minor ticks
*
* when autoTickInterval is set to false: minor ticks is exactly the user set by {@link #setMinorTicks(Integer)}.
* The Default number is zero, means not shown by default.
*
* @param flag
*/
public void setAutoMinorTicks(boolean flag);
/**
* Return the number of minor ticks displayed between two major ticks. This method always returns the number set by
* {@link #setMinorTicks(Integer)}, no matter if the actual number has been adjusted.
*
* @return the number of minor ticks displayed
*/
@Property(order = 19, styleable = false)
public int getMinorTicks();
/**
* Set the number of minor ticks displayed between two major ticks. The actual number may be adjusted, and not equal
* the number set by this method.
*
* Setting a new minor number will set autoMinornumber to false.
*
* @param minors
* the number of minor ticks displayed
*/
public void setMinorTicks(int minors);
/**
* Return the number of minor ticks displayed between two major ticks. This method returns the actual number, might
* be different form the number set by {@link #setMinorTicks(Integer)}.
*
* @return the number of minor ticks displayed
*/
@Property(order = 20, styleable = false)
public int getActualMinorTicks();
/**
* Return an array of number representing the tick positions shown in the axis.
*
* @return the values of the ticks
*/
@Property(order = 21, styleable = false)
public Object getTickValues();
/**
* Return an array of number representing the minor tick positions shown in the axis.
*
* @return the values of the ticks
*/
@Property(order = 22, styleable = false)
public Object getMinorTickValues();
/* =========================== Labels ============================= */
/**
* Get the label interval. The tick labels are displayed after that number of ticks
*
* @return label interval
*/
@Property(order = 30, styleable = false)
public int getLabelInterval();
/**
* Set the tick labels displayed after n ticks
*
* @param n
* label displayed each n ticks .
*/
public void setLabelInterval(int n);
/**
* Returns true if labels format is auto calculated or assigned by {@link #setLabelFormat(String)}
*
* @return true if labels format is auto calculated
*/
@Property(order = 40, styleable = false)
public boolean isAutoLabelFormat();
/**
* Sets true to auto calculate proper labels format. Or sets false to assign a label
* format by {@link #setLabelFormat(String)}
*
* @param alf
* the flag
*/
public void setAutoLabelFormat(boolean alf);
/**
* Returns the format of the labels of ticks.
*
* @return the format of the labels.
*/
@Property(order = 41, styleable = false)
public Format getLabelTextFormat();
/**
* Sets the format object that is used to format the tick labels from tick values. If this text format is null, the
* printf-style format will be used to format the labels.
*
* Setting a new labelTextFormat will set autoLabelFormat to false
*
* @param format
* the format object
*/
public void setLabelTextFormat(Format format);
/**
* Returns the printf-style format of the labels of ticks.
*
* @return the format of the labels.
*/
@Property(order = 42, styleable = false)
public String getLabelFormat();
/**
* Sets the printf-style format that is used to format the tick labels from tick values. The syntax of format string
* is described in {@link java.util.Formatter}. Beside the standard Java formatter conversions, a special conversion
* 'm' can be used to produce labels in n_10^e format. The usage of conversion 'm' is like the standard conversion
* 'e'.
*
* Setting a new labelFormat will set autoLabelFormat to false
*
* @param format
* the format string, or null to used the auto format.
*/
public void setLabelFormat(String format);
/**
* Returns the user assigned substitute labels. null has a special meaning of "undecided".
*
* @return the user assigned substitute labels.
*/
@Property(order = 43, styleable = false)
public String[] getFixedLabelStrings();
/**
* Set an array of String to substitute the labels of the fixed ticks. If the length of the array is shorter then
* the number of fixed ticks, only the first ticks are changed, if the length of the array is longer then the number
* of ticks only the first labels are used. null in the array means not substitute the label. The given labels can
* be null or a empty array.
*
* If the tick is autoValues mode (a.k.a. no fixedValues assigned), the given fixedLabels will substitute the auto
* labels of visible ticks.
*
* @see #setFixedTickValues(Object)
* @param labels
* the new labels to be displayed in the ticks
*/
public void setFixedLabelStrings(String[] labels);
/**
* Return an array of string representing the labels shown in the axis.
*
* @return the labels of the ticks
*/
@Property(order = 44, styleable = false)
public String[] getLabelStrings();
}
Ads help maintain this website.