jhplot.jadraw
Class JaLine

java.lang.Object
  extended by jhplot.jadraw.JaObject
      extended by jhplot.jadraw.JaLineObject
          extended by jhplot.jadraw.JaLine
All Implemented Interfaces:
Serializable

public class JaLine
extends JaLineObject

Build a simple line

See Also:
Serialized Form

Field Summary
 
Fields inherited from class jhplot.jadraw.JaObject
BB_MAX_X, BB_MAX_Y, BB_MIN_X, BB_MIN_Y, COPY, D_FORMAT, INIT_SIZE, LENGTH, MOVE, RESIZE, SELECT_BODY, SELECT_LL, SELECT_LR, SELECT_NONE, SELECT_P1, SELECT_P2, SELECT_P3, SELECT_UL, SELECT_UR
 
Constructor Summary
JaLine()
          Constructor: calls super() and initializes inflip to false.
JaLine(double x1, double y1, double x2, double y2, String what)
          Build a line
 
Method Summary
 JaObject copy()
          Returns an exact copy of this JaFLine.
 boolean editPanel()
          Brings up the edit panel that allows to change the parameters of this object.
 float getPenWidth()
          Get line width
 float getTransparency()
          Get the transparency of it
 boolean isCopy(JaObject comp)
          Returns true if all serializable variables of this JaObject and those of the specified one are equal.
 void jaxoDraw(org.freehep.graphics2d.VectorGraphics g2, boolean drawToScreen)
          The method that draws this JaFLine.
 String latexCommand(float scale, Dimension canvasDim)
          The LaTeX command that is necessary to draw this JaFLine using the axodraw.sty package.
 void setLocationXY(int xin, int yin, int xfin, int yfin)
          Set location in pixel coordinates
 void setPenWidth(float penwidth)
          Set line width
 void setTransparency(float transp)
          Set transparency of this object
 
Methods inherited from class jhplot.jadraw.JaLineObject
baseEditPanel, drawHandles, getAmp, getArrow, getBack, getDash, getDLSeparation, getDoubleLine, getEnd, getFlip, getFreq, getGrabbedHandle, getInflip, getStroke, getSymm, isArrow, isBack, isEnd, isFlip, isInflip, isSymm, latexWidth, rescaleObject, setAmp, setArrow, setBack, setDash, setDLSeparation, setDoubleLine, setEnd, setFlip, setFreq, setInflip, setStroke, setSymm
 
Methods inherited from class jhplot.jadraw.JaObject
drawVisualAid, getBoundingBox, getColor, getGeneralPath, getHeight, getRelh, getRelHndc, getRelHuser, getRelSize, getRelw, getRelWndc, getRelWuser, getSize, getWidth, getX, getXndc, getXuser, getY, getYndc, getYuser, isMarked, isUser, moveBy, scalePoint, setAsMarked, setBoundingBox, setColor, setLocation, setLocation, setRelh, setRelw, setRelWAndH, setRelWH, setSize, setX, setY, updateCoor, updateNDC
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

JaLine

public JaLine(double x1,
              double y1,
              double x2,
              double y2,
              String what)
Build a line

Parameters:
x1 - starting x
y1 - starting y
x2 - end of x
y2 - end of y
what - if "NDC", coordinate in NDC (from 0 to 1), if "USER" coordinates are in the user system given by the axes.

JaLine

public JaLine()
Constructor: calls super() and initializes inflip to false.

Method Detail

setLocationXY

public void setLocationXY(int xin,
                          int yin,
                          int xfin,
                          int yfin)
Set location in pixel coordinates

Parameters:
xin - x min
yin - y min
xfin - x max
yfin - y max

getPenWidth

public float getPenWidth()
Get line width

Parameters:
pen - width

setPenWidth

public void setPenWidth(float penwidth)
Set line width

Parameters:
penwidth - pen width

copy

public final JaObject copy()
Returns an exact copy of this JaFLine.

Specified by:
copy in class JaObject
Returns:
A copy of this JaFLine.

setTransparency

public void setTransparency(float transp)
Set transparency of this object

Parameters:
transp - transparency from 0 to 1

getTransparency

public float getTransparency()
Get the transparency of it

Returns:
transparency

isCopy

public final boolean isCopy(JaObject comp)
Returns true if all serializable variables of this JaObject and those of the specified one are equal.

Specified by:
isCopy in class JaObject
Parameters:
comp - A JaObject to compare with.
Returns:
True if the objects are equal, false otherwise.

jaxoDraw

public final void jaxoDraw(org.freehep.graphics2d.VectorGraphics g2,
                           boolean drawToScreen)
The method that draws this JaFLine.

Specified by:
jaxoDraw in class JaObject
Parameters:
g2 - The graphics context where the JaFLine has to be drawn.
drawToScreen - A boolean variable that indicates whether the drawing is done on the screen or somewhere else. This is used for exporting/printing, where the object handles should not be painted, even if they are visible on the screen.

latexCommand

public final String latexCommand(float scale,
                                 Dimension canvasDim)
The LaTeX command that is necessary to draw this JaFLine using the axodraw.sty package.

Specified by:
latexCommand in class JaObject
Parameters:
scale - A scale factor to translate Java coordinates to LaTeX coordinates.
canvasDim - The current dimension of the canvas.
Returns:
The corresponding axodraw LaTeX command.

editPanel

public final boolean editPanel()
Brings up the edit panel that allows to change the parameters of this object.

Specified by:
editPanel in class JaObject
Returns:
True if the editing actually changed the object, false if the object has not been changed.


jHepWork 3.0 ©