net.sf.latexdraw.glib.models.interfaces
Interface IAxes

All Superinterfaces:
IArrowable, IPositionShape, IShape, IStandardGrid, Modifiable
All Known Subinterfaces:
IGroup
All Known Implementing Classes:
LAxes, LDrawing, LGroup

public interface IAxes
extends IStandardGrid

Defines an interface that classes defining latex axes should implement.

This file is part of LaTeXDraw.
Copyright (c) 2005-2012 Arnaud BLOUIN

LaTeXDraw 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 2 of the License, or (at your option) any later version.
LaTeXDraw is distributed 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.

07/03/2009

Since:
3.0
Version:
3.0
Author:
Arnaud BLOUIN

Nested Class Summary
static class IAxes.AxesStyle
          Defines the different kinds of axes.
static class IAxes.PlottingStyle
          Defines the different style of labels.
static class IAxes.TicksStyle
          Defines the different kinds of ticks.
 
Nested classes/interfaces inherited from interface net.sf.latexdraw.glib.models.interfaces.IShape
IShape.BorderPos, IShape.FillingStyle, IShape.LineStyle, IShape.Position
 
Field Summary
static double GAP_LABEL
          The interval between the labels and the axes.
 
Fields inherited from interface net.sf.latexdraw.glib.models.interfaces.IShape
GOLDEN_ANGLE, PPC
 
Method Summary
 IAxes duplicate()
          Creates a duplicate of the shape (however id are not the same).
 IAxes.AxesStyle getAxesStyle()
           
 IPoint getDistLabels()
           
 double getDistLabelsX()
           
 double getDistLabelsY()
           
 IPoint getIncrement()
           
 double getIncrementX()
           
 double getIncrementY()
           
 IAxes.PlottingStyle getLabelsDisplayed()
           
 IAxes.PlottingStyle getTicksDisplayed()
           
 double getTicksSize()
           
 IAxes.TicksStyle getTicksStyle()
           
 boolean isShowOrigin()
           
 void setAxesStyle(IAxes.AxesStyle axesStyle)
           
 void setDistLabels(IPoint distLabels)
           
 void setDistLabelsX(double distLabelsX)
           
 void setDistLabelsY(double distLabelsY)
           
 void setIncrement(IPoint increment)
           
 void setIncrementX(double increment)
           
 void setIncrementY(double increment)
           
 void setLabelsDisplayed(IAxes.PlottingStyle labelsDisplayed)
           
 void setShowOrigin(boolean showOrigin)
           
 void setTicksDisplayed(IAxes.PlottingStyle ticksDisplayed)
           
 void setTicksSize(double ticksSize)
           
 void setTicksStyle(IAxes.TicksStyle ticksStyle)
           
 
Methods inherited from interface net.sf.latexdraw.glib.models.interfaces.IStandardGrid
getGridEnd, getGridEndX, getGridEndY, getGridMaxX, getGridMaxY, getGridMinX, getGridMinY, getGridStart, getGridStartX, getGridStartY, getLabelsSize, getOriginX, getOriginY, getStep, isXLabelSouth, isYLabelWest, setGridEnd, setGridEndX, setGridEndY, setGridStart, setGridStartX, setGridStartY, setLabelsSize, setOrigin, setOriginX, setOriginY, setXLabelSouth, setYLabelWest
 
Methods inherited from interface net.sf.latexdraw.glib.models.interfaces.IPositionShape
getPosition, getX, getY, setPosition, setPosition, setX, setY
 
Methods inherited from interface net.sf.latexdraw.glib.models.interfaces.IShape
addToRotationAngle, copy, getArrowAt, getArrowLine, getArrows, getArrowStyle, getBorderGap, getBordersPosition, getBottomLeftPoint, getBottomRightPoint, getDashSepBlack, getDashSepWhite, getDbleBordCol, getDbleBordSep, getDotSep, getFillingCol, getFillingStyle, getFullBottomRightPoint, getFullTopLeftPoint, getGradAngle, getGradColEnd, getGradColStart, getGradMidPt, getGravityCentre, getHatchingsAngle, getHatchingsCol, getHatchingsSep, getHatchingsWidth, getId, getLineColour, getLineStyle, getNbPoints, getOpacity, getPoints, getPtAt, getRotationAngle, getShadowAngle, getShadowCol, getShadowGap, getShadowSize, getThickness, getTopLeftPoint, getTopRightPoint, hasDbleBord, hasGradient, hasHatchings, hasShadow, isArrowable, isBordersMovable, isColourable, isDbleBorderable, isFillable, isFilled, isInteriorStylable, isLineStylable, isParametersEquals, isShadowable, isShowPts, isShowPtsable, isThicknessable, mirrorHorizontal, mirrorVertical, rotate, scale, setArrowStyle, setBordersPosition, setDashSepBlack, setDashSepWhite, setDbleBordCol, setDbleBordSep, setDotSep, setFilled, setFillingCol, setFillingStyle, setGradAngle, setGradColEnd, setGradColStart, setGradMidPt, setHasDbleBord, setHasShadow, setHatchingsAngle, setHatchingsCol, setHatchingsSep, setHatchingsWidth, setId, setLineColour, setLineStyle, setNewId, setOpacity, setRotationAngle, setShadowAngle, setShadowCol, setShadowSize, setShowPts, setThickness, shadowFillsShape, translate
 
Methods inherited from interface org.malai.properties.Modifiable
isModified, setModified
 
Methods inherited from interface net.sf.latexdraw.glib.models.interfaces.IArrowable
getArrowInset, getArrowLength, getArrowSizeDim, getArrowSizeNum, getBracketNum, getDotSizeDim, getDotSizeNum, getRBracketNum, getTBarSizeDim, getTBarSizeNum, setArrowInset, setArrowLength, setArrowSizeDim, setArrowSizeNum, setBracketNum, setDotSizeDim, setDotSizeNum, setRBracketNum, setTBarSizeDim, setTBarSizeNum
 

Field Detail

GAP_LABEL

static final double GAP_LABEL
The interval between the labels and the axes.

See Also:
Constant Field Values
Method Detail

duplicate

IAxes duplicate()
Description copied from interface: IShape
Creates a duplicate of the shape (however id are not the same).

Specified by:
duplicate in interface IShape
Returns:
The duplicata.

getIncrementX

double getIncrementX()
Returns:
The X increment of the axes.
Since:
3.0

getIncrementY

double getIncrementY()
Returns:
The Y increment of the axes.
Since:
3.0

getIncrement

IPoint getIncrement()
Returns:
The increments of the axes.
Since:
3.0

setIncrementX

void setIncrementX(double increment)
Parameters:
increment - the X increment to set.

setIncrementY

void setIncrementY(double increment)
Parameters:
increment - the Y increment to set.

setIncrement

void setIncrement(IPoint increment)
Parameters:
increment - The axes' increment to set.

getDistLabels

IPoint getDistLabels()
Returns:
The distance between the labels of the axes.

getDistLabelsX

double getDistLabelsX()
Returns:
the distLabels.x.

getDistLabelsY

double getDistLabelsY()
Returns:
the distLabels.y.

setDistLabels

void setDistLabels(IPoint distLabels)
Parameters:
distLabels - The distance between the labels of the axes.

setDistLabelsX

void setDistLabelsX(double distLabelsX)
Parameters:
distLabelsX - the distLabels.x to set.

setDistLabelsY

void setDistLabelsY(double distLabelsY)
Parameters:
distLabelsY - the distLabels.y to set.

getLabelsDisplayed

IAxes.PlottingStyle getLabelsDisplayed()
Returns:
the labelsDisplayed.

setLabelsDisplayed

void setLabelsDisplayed(IAxes.PlottingStyle labelsDisplayed)
Parameters:
labelsDisplayed - the labelsDisplayed to set.

isShowOrigin

boolean isShowOrigin()
Returns:
the showOrigin.

setShowOrigin

void setShowOrigin(boolean showOrigin)
Parameters:
showOrigin - the showOrigin to set.

getTicksDisplayed

IAxes.PlottingStyle getTicksDisplayed()
Returns:
the ticksDisplayed.

setTicksDisplayed

void setTicksDisplayed(IAxes.PlottingStyle ticksDisplayed)
Parameters:
ticksDisplayed - the ticksDisplayed to set.

getTicksStyle

IAxes.TicksStyle getTicksStyle()
Returns:
the ticksStyle.

setTicksStyle

void setTicksStyle(IAxes.TicksStyle ticksStyle)
Parameters:
ticksStyle - the ticksStyle to set.

getTicksSize

double getTicksSize()
Returns:
the ticksSize.

setTicksSize

void setTicksSize(double ticksSize)
Parameters:
ticksSize - the ticksSize to set.

getAxesStyle

IAxes.AxesStyle getAxesStyle()
Returns:
the axesStyle.

setAxesStyle

void setAxesStyle(IAxes.AxesStyle axesStyle)
Parameters:
axesStyle - the axesStyle to set.