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

All Superinterfaces:
IArrowable, IPositionShape, IShape, Modifiable
All Known Subinterfaces:
IAxes, IGrid, IGroup
All Known Implementing Classes:
LAbstractGrid, LAxes, LDrawing, LGrid, LGroup

public interface IStandardGrid
extends IPositionShape

Defines an interface that classes defining a model for latex grid 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
 
Nested classes/interfaces inherited from interface net.sf.latexdraw.glib.models.interfaces.IShape
IShape.BorderPos, IShape.FillingStyle, IShape.LineStyle, IShape.Position
 
Field Summary
 
Fields inherited from interface net.sf.latexdraw.glib.models.interfaces.IShape
GOLDEN_ANGLE, PPC
 
Method Summary
 IPoint getGridEnd()
           
 double getGridEndX()
           
 double getGridEndY()
           
 double getGridMaxX()
           
 double getGridMaxY()
           
 double getGridMinX()
           
 double getGridMinY()
           
 IPoint getGridStart()
           
 double getGridStartX()
           
 double getGridStartY()
           
 int getLabelsSize()
           
 double getOriginX()
           
 double getOriginY()
           
 double getStep()
           
 boolean isXLabelSouth()
           
 boolean isYLabelWest()
           
 void setGridEnd(double x, double y)
           
 void setGridEndX(double x)
           
 void setGridEndY(double y)
           
 void setGridStart(double x, double y)
           
 void setGridStartX(double x)
           
 void setGridStartY(double y)
           
 void setLabelsSize(int labelsSize)
          Defines the size of the labels.
 void setOrigin(double x, double y)
           
 void setOriginX(double x)
           
 void setOriginY(double y)
           
 void setXLabelSouth(boolean isXLabelSouth)
           
 void setYLabelWest(boolean isYLabelWest)
           
 
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, duplicate, 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
 

Method Detail

getGridMinX

double getGridMinX()
Returns:
The minimal X-tick of the grid.
Since:
3.0

getGridMaxX

double getGridMaxX()
Returns:
The maximal X-tick of the grid.
Since:
3.0

getGridMinY

double getGridMinY()
Returns:
The minimal Y-tick of the grid.
Since:
3.0

getGridMaxY

double getGridMaxY()
Returns:
The maximal Y-tick of the grid.
Since:
3.0

getLabelsSize

int getLabelsSize()
Returns:
The size of the labels.
Since:
3.0

setLabelsSize

void setLabelsSize(int labelsSize)
Defines the size of the labels.

Parameters:
labelsSize - The new size of the labels.
Since:
3.0

setGridEndX

void setGridEndX(double x)
Parameters:
x - The x-coordinate to set.

setGridEndY

void setGridEndY(double y)
Parameters:
y - The y-coordinate to set.

isXLabelSouth

boolean isXLabelSouth()
Returns:
the isXLabelSouth.

setXLabelSouth

void setXLabelSouth(boolean isXLabelSouth)
Parameters:
isXLabelSouth - the isXLabelSouth to set.

isYLabelWest

boolean isYLabelWest()
Returns:
the isYLabelWest.

setYLabelWest

void setYLabelWest(boolean isYLabelWest)
Parameters:
isYLabelWest - the isYLabelWest to set.

getGridStartX

double getGridStartX()
Returns:
The x-coordinate of the starting point of the grid.

getGridStartY

double getGridStartY()
Returns:
The y-coordinate of the starting point of the grid.

getGridStart

IPoint getGridStart()
Returns:
The starting point of the grid.
Since:
3.0

getGridEnd

IPoint getGridEnd()
Returns:
The ending point of the grid.
Since:
3.0

setGridStart

void setGridStart(double x,
                  double y)
Parameters:
x - The x-coordinate of the starting point of the grid.
y - The y-coordinate of the starting point of the grid.

getGridEndX

double getGridEndX()
Returns:
The x-coordinate of the ending point of the grid.

getGridEndY

double getGridEndY()
Returns:
The y-coordinate of the ending point of the grid.

setGridEnd

void setGridEnd(double x,
                double y)
Parameters:
x - The x-coordinate of the ending point of the grid.
y - The y-coordinate of the ending point of the grid.

getOriginX

double getOriginX()
Returns:
The x-coordinate of the origin.

getOriginY

double getOriginY()
Returns:
The y-coordinate of the origin.

setOrigin

void setOrigin(double x,
               double y)
Parameters:
x - The x-coordinate of the origin of the grid.
y - The y-coordinate of the origin of the grid.

setGridStartY

void setGridStartY(double y)
Parameters:
y - The y-coordinate to set.

setGridStartX

void setGridStartX(double x)
Parameters:
x - The x-coordinate to set.

setOriginX

void setOriginX(double x)
Parameters:
x - The X-coordinate to set.

setOriginY

void setOriginY(double y)
Parameters:
y - The Y-coordinate to set.

getStep

double getStep()
Returns:
The size of a step of the grid (can be LShape.PPC or LShape.PPC*unit for instance).
Since:
3.0