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

All Superinterfaces:
IArrowable, IPositionShape, IShape, IStandardGrid, Modifiable
All Known Implementing Classes:
LGrid

public interface IGrid
extends IStandardGrid

Defines an interface that classes defining a 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
 IGrid duplicate()
          Creates a duplicate of the shape (however id are not the same).
 int getGridDots()
           
 java.awt.Color getGridLabelsColour()
           
 double getGridWidth()
           
 java.awt.Color getSubGridColour()
           
 int getSubGridDiv()
           
 int getSubGridDots()
           
 double getSubGridWidth()
           
 double getUnit()
           
 void setGridDots(int gridDots)
           
 void setGridLabelsColour(java.awt.Color gridLabelsColour)
           
 void setGridWidth(double gridWidth)
           
 void setSubGridColour(java.awt.Color subGridColour)
           
 void setSubGridDiv(int subGridDiv)
           
 void setSubGridDots(int subGridDots)
           
 void setSubGridWidth(double subGridWidth)
           
 void setUnit(double unit)
           
 
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
 

Method Detail

duplicate

IGrid 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.

getGridDots

int getGridDots()
Returns:
Returns the gridDots.

setGridDots

void setGridDots(int gridDots)
Parameters:
gridDots - The gridDots to set. Must be greater or equal than 0.

getGridLabelsColour

java.awt.Color getGridLabelsColour()
Returns:
Returns the gridLabelsColor.

setGridLabelsColour

void setGridLabelsColour(java.awt.Color gridLabelsColour)
Parameters:
gridLabelsColour - The gridLabelsColor to set.

getGridWidth

double getGridWidth()
Returns:
Returns the gridWidth.

setGridWidth

void setGridWidth(double gridWidth)
Parameters:
gridWidth - The gridWidth to set. Must be greater than 0.

getSubGridColour

java.awt.Color getSubGridColour()
Returns:
Returns the subGridColor.

setSubGridColour

void setSubGridColour(java.awt.Color subGridColour)
Parameters:
subGridColour - The subGridColor to set.

getSubGridDiv

int getSubGridDiv()
Returns:
Returns the subGridDiv.

setSubGridDiv

void setSubGridDiv(int subGridDiv)
Parameters:
subGridDiv - The subGridDiv to set. Must be greater or equal than 0.

getSubGridDots

int getSubGridDots()
Returns:
Returns the subGridDots.

setSubGridDots

void setSubGridDots(int subGridDots)
Parameters:
subGridDots - The subGridDots to set. Must be greater or equal than 0.

getSubGridWidth

double getSubGridWidth()
Returns:
Returns the subGridWidth.

setSubGridWidth

void setSubGridWidth(double subGridWidth)
Parameters:
subGridWidth - The subGridWidth to set. Must be greater than 0.

setUnit

void setUnit(double unit)
Parameters:
unit - The unit to set. Must be greater than 0.

getUnit

double getUnit()
Returns:
Returns the unit.