jhplot.jadraw
Class JaKey
- java.lang.Object
-
- jhplot.jadraw.JaObject
-
- jhplot.jadraw.JaKey
-
- All Implemented Interfaces:
- java.io.Serializable
public class JaKey extends JaObject
Defines a key with the text- See Also:
- Serialized Form
-
-
Constructor Summary
Constructors Constructor and Description JaKey()
Constructor: sets the width, height, relative width and height to a default value of 2.JaKey(int key, java.lang.String text, double x1, double y1, java.lang.String what)
Build a line
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method and Description JaObject
copy()
Returns an exact copy of this label.void
drawHandles(org.freehep.graphics2d.VectorGraphics g2)
Draws the handles of this text object.boolean
editPanel()
Brings up the edit panel that allows to change the parameters of this object.java.awt.Font
getFont()
Returns the textFont property of this text object.int
getGrabbedHandle(int clickX, int clickY, int editmode)
Determines where on this JaObject a mouse click has ocurred.int
getKey()
Get current key symbol.java.awt.Color
getKeyColor()
Get key colordouble
getKeySpace()
Get space between a text and the keyint
getPadX()
Get pad ID in Xint
getPadY()
Get pad ID in Yfloat
getPenWidth()
Get pen width used to draw the keyint
getRotAngle()
Returns the rotAngle property of this text object.java.lang.String
getText()
Returns the textString property of this text object.int
getType()
Get type of this objectboolean
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 label.java.lang.String
latexCommand(float scale, java.awt.Dimension canvasDim)
The LaTeX command that is necessary to draw the given label using the axodraw.sty package.java.lang.String
latexWidth()
Returns the line width of this label.void
print()
void
rescaleObject(int orx, int ory, float scale)
Rescales this label by the scale factor scale, keeping the point (orx, ory) fixed.void
setAvailableFonts(java.lang.String[] fonts)
Sets the string array of available fonts.void
setFont(java.awt.Font font)
Sets the textFont property of this text object.void
setKey(int key)
Set the key symbol (1-12, 20,21,22)void
setKeyColor(java.awt.Color color)
Set the key colorvoid
setKeySpace(double space)
Set a space between a key and a textvoid
setPadX(int pad)
Set pad ID in Xvoid
setPadY(int pad)
Set pad ID in Yvoid
setPenWidth(float penwidth)
Set a pen width used to draw the keyvoid
setRotAngle(int angle)
Sets the rotAngle property of this text object.void
setText(java.lang.String string)
Sets the textString property of this text object.void
setType(int type)
Set type of this object-
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
-
-
-
-
Constructor Detail
-
JaKey
public JaKey()
Constructor: sets the width, height, relative width and height to a default value of 2.
-
JaKey
public JaKey(int key, java.lang.String text, double x1, double y1, java.lang.String what)
Build a line- Parameters:
key
- key identification (1-12, 20, 21, 22)text
- text stringx1
- starting xy1
- starting ywhat
- if "NDC", coordinate in NDC (from 0 to 1), if "USER" coordinates are in the user system given by the axes.
-
-
Method Detail
-
setType
public void setType(int type)
Set type of this object- Parameters:
type
- type
-
getType
public int getType()
Get type of this object- Returns:
- type
-
setPadX
public void setPadX(int pad)
Set pad ID in X- Parameters:
pad
- pad id
-
getPadX
public int getPadX()
Get pad ID in X- Returns:
- pad ID
-
setPadY
public void setPadY(int pad)
Set pad ID in Y- Parameters:
pad
- pad id
-
getPadY
public int getPadY()
Get pad ID in Y- Returns:
- pad ID
-
getFont
public final java.awt.Font getFont()
Returns the textFont property of this text object.- Returns:
- The textFont property of this text object.
-
getKey
public final int getKey()
Get current key symbol.- Returns:
-
setKey
public final void setKey(int key)
Set the key symbol (1-12, 20,21,22)- Parameters:
key
- key symbol
-
getKeySpace
public final double getKeySpace()
Get space between a text and the key- Returns:
- space in NDC coordinate system
-
setKeySpace
public final void setKeySpace(double space)
Set a space between a key and a text- Parameters:
space
- space between key and the text in NDC
-
getKeyColor
public final java.awt.Color getKeyColor()
Get key color- Returns:
- key color
-
setKeyColor
public final void setKeyColor(java.awt.Color color)
Set the key color- Parameters:
color
- key color
-
getPenWidth
public float getPenWidth()
Get pen width used to draw the key- Returns:
- pen width
-
setPenWidth
public void setPenWidth(float penwidth)
Set a pen width used to draw the key- Parameters:
penwidth
-
-
setFont
public final void setFont(java.awt.Font font)
Sets the textFont property of this text object.- Parameters:
font
- The textFont 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.
-
getText
public final java.lang.String getText()
Returns the textString property of this text object.- Returns:
- The textString property of this text object.
-
setText
public final void setText(java.lang.String string)
Sets the textString property of this text object.- Parameters:
string
- The textString property of this text object.
-
copy
public final JaObject copy()
Returns an exact copy of this label.
-
isCopy
public final boolean isCopy(JaObject comp)
Returns true if all serializable variables of this JaObject and those of the specified one are equal.
-
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 classJaObject
- 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 label.
-
drawHandles
public final void drawHandles(org.freehep.graphics2d.VectorGraphics g2)
Draws the handles of this text object.- Specified by:
drawHandles
in classJaObject
- Parameters:
g2
- The current graphics context.
-
latexCommand
public final java.lang.String latexCommand(float scale, java.awt.Dimension canvasDim)
The LaTeX command that is necessary to draw the given label using the axodraw.sty package. This is not used for label.- Specified by:
latexCommand
in classJaObject
- Parameters:
scale
- A scale factor to translate Java coordinates to LaTeX coordinates.canvasDim
- The current dimension of the canvas.- Returns:
- A string that appears as a comment in the Latex file, indicating that there is a postscript text here.
-
rescaleObject
public final void rescaleObject(int orx, int ory, float scale)
Rescales this label by the scale factor scale, keeping the point (orx, ory) fixed.- Specified by:
rescaleObject
in classJaObject
- Parameters:
orx
- The x-coordinate of the fixed pointory
- The y-coordinate of the fixed pointscale
- The scale parameter
-
latexWidth
public final java.lang.String latexWidth()
Returns the line width of this label. This is not used for label.- Specified by:
latexWidth
in classJaObject
- Returns:
- Returns "%", corresponding to an empty comment line in LaTeX.
-
editPanel
public final boolean editPanel()
Brings up the edit panel that allows to change the parameters of this object.
-
setAvailableFonts
public final void setAvailableFonts(java.lang.String[] fonts)
Sets the string array of available fonts.- Parameters:
fonts
- The string array of available fonts.
-
print
public final void print()
-
-
DMelt 3.0 © DataMelt by jWork.ORG