jhplot.jadraw

Class JaLatexText

java.lang.Object

jhplot.jadraw.JaObject

jhplot.jadraw.JaLatexText

All Implemented Interfaces:

Serializable

public class JaLatexText
extends JaObject

Defines a JaObject which is just a string.

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

Constructors

Constructor and Description
JaLatexText() Constructor: sets the width, height, relative width and height to a default value of 3.

Method Summary

Methods

Modifier and Type	Method and Description
JaObject	copy() Returns an exact copy of this JaLatexText.
void	createLatexPanel() Creates a new Panel that display a Label with the String specifying this JaLatexText.
void	drawHandles(org.freehep.graphics2d.VectorGraphics g2) Draws the handles of this text object.
void	drawTexVisualAid(org.freehep.graphics2d.VectorGraphics g2) Draws a visual aid for a tex label: a blu TeX icon.
boolean	editPanel() Brings up the edit panel that allows to change the parameters of this object.
int	getAllign() Returns the allign property of this text object.
double[]	getBoundingBox() Returns the bounding box of this latex text object.
int	getGrabbedHandle(int clickX, int clickY, int editmode) Determines where on this JaObject a mouse click has ocurred.
int	getLatexFS() Returns the latexfs property of this text object.
JPanel	getLatexPanel() Returns the Panel that holds the String specifying this LatexText.
int	getRotAngle() Returns the rotAngle property of this text object.
String	getTextString() Returns the textString property of this text object.
boolean	isCopy(JaObject comp) Returns true if all serializable variables of this JaObject and those of the specified one are equal.
boolean	isRolledOver(int mouseX, int mouseY) Determines whether the curser is currently above the visual aid icon of this LatexText.
void	jaxoDraw(org.freehep.graphics2d.VectorGraphics g2, boolean drawToScreen) The method that draws this JaxoText.
String	latexCommand(float scale, Dimension canvasDim) The LaTeX command that is necessary to draw the given JaxoText using the axodraw.sty package.
String	latexWidth() Returns the line width of this JaxoText.
void	rescaleObject(int orx, int ory, float scale) Rescales this JaxoText by the scale factor scale, keeping the point (orx, ory) fixed.
void	setAllign(int newAllign) Sets the allign property of this text object.
void	setLatexFS(int newLatexfs) Sets the latexfs property of this text object.
void	setLatexLabel(String str) Sets the Label of this LatexText to str.
void	setRotAngle(int angle) Sets the rotAngle property of this text object.
void	setTextString(String string) Sets the textString property of this text object.

Methods inherited from class jhplot.jadraw.JaObject

drawVisualAid, 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

JaLatexText

public JaLatexText()

Constructor: sets the width, height, relative width and height to a default value of 3.

Method Detail

createLatexPanel

public final void createLatexPanel()

Creates a new Panel that display a Label with the String specifying this JaLatexText.

getLatexPanel

public final JPanel getLatexPanel()

Returns the Panel that holds the String specifying this LatexText.

Returns:

A JPanel.

setLatexLabel

public final void setLatexLabel(String str)

Sets the Label of this LatexText to str.

Parameters:

str - The string to be set as label.

getTextString

public final String getTextString()

Returns the textString property of this text object.

Returns:

The textString property of this text object.

setTextString

public final void setTextString(String string)

Sets the textString property of this text object.

Parameters:

string - The textString property of this text object.

getAllign

public final int getAllign()

Returns the allign property of this text object.

Returns:

The allign property of this text object.

setAllign

public final void setAllign(int newAllign)

Sets the allign property of this text object.

Parameters:

newAllign - The allign property of this text object.

getLatexFS

public final int getLatexFS()

Returns the latexfs property of this text object.

Returns:

The latexfs property of this text object.

setLatexFS

public final void setLatexFS(int newLatexfs)

Sets the latexfs property of this text object.

Parameters:

newLatexfs - The latexfs property of this text object.

getRotAngle

public final int getRotAngle()

Returns the rotAngle property of this text object.

Returns:

The rotAngle property of this text object.

setRotAngle

public final void setRotAngle(int angle)

Sets the rotAngle property of this text object.

Parameters:

angle - The rotAngle property of this text object.

copy

public final JaObject copy()

Returns an exact copy of this JaLatexText.

Specified by:

copy in class JaObject

Returns:

A copy of this JaLatexText.

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.

getGrabbedHandle

public final int getGrabbedHandle(int clickX,
                   int clickY,
                   int editmode)

Determines where on this JaObject a mouse click has ocurred.

Specified by:

getGrabbedHandle in class JaObject

Parameters:

clickX - The x position of the point where the mouse click ocurred.

clickY - The y position of the point where the mouse click ocurred.

editmode - The current edit mode as defined in JaxoMainPanel.

Returns:

An integer specifying whether the click ocurred on one of the handles and if yes, on which.

jaxoDraw

public final void jaxoDraw(org.freehep.graphics2d.VectorGraphics g2,
            boolean drawToScreen)

The method that draws this JaxoText.

Specified by:

jaxoDraw in class JaObject

Parameters:

g2 - The graphics context where the JaxoText 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.

drawTexVisualAid

public final void drawTexVisualAid(org.freehep.graphics2d.VectorGraphics g2)

Draws a visual aid for a tex label: a blu TeX icon.

Parameters:

g2 - The graphics context to draw to

isRolledOver

public final boolean isRolledOver(int mouseX,
                   int mouseY)

Determines whether the curser is currently above the visual aid icon of this LatexText.

Parameters:

mouseX - The current x - coordinate of the cursor

mouseY - The current y - coordinate of the cursor

Returns:

A boolean variable

drawHandles

public final void drawHandles(org.freehep.graphics2d.VectorGraphics g2)

Draws the handles of this text object.

Specified by:

drawHandles in class JaObject

Parameters:

g2 - The current graphics context.

getBoundingBox

public final double[] getBoundingBox()

Returns the bounding box of this latex text object.

Overrides:

getBoundingBox in class JaObject

Returns:

The bounding box.

latexCommand

public final String latexCommand(float scale,
                  Dimension canvasDim)

The LaTeX command that is necessary to draw the given JaxoText 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.

latexWidth

public final String latexWidth()

Returns the line width of this JaxoText. This is not used for JaxoText.

Specified by:

latexWidth in class JaObject

Returns:

Returns "%", corresponding to an empty comment line in LaTeX.

rescaleObject

public final void rescaleObject(int orx,
                 int ory,
                 float scale)

Rescales this JaxoText by the scale factor scale, keeping the point (orx, ory) fixed.

Specified by:

rescaleObject in class JaObject

Parameters:

orx - The x - coordinate of the fixed point

ory - The y - coordinate of the fixed point

scale - The scale parameter

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.