jhplot.jadraw
Class JaTextBox

java.lang.Object
  extended by jhplot.jadraw.JaObject
      extended by jhplot.jadraw.JaFillObject
          extended by jhplot.jadraw.JaTextBox
All Implemented Interfaces:
java.io.Serializable

public class JaTextBox
extends JaFillObject

Text label which can be either one text line or multiline. The text is in box.

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
JaTextBox()
          Constructor: sets the width, height, getRelw() and getRelh() to a default value of 25.
 
Method Summary
 JaObject copy()
          Returns an exact copy of this Label.
 void drawHandles(org.freehep.graphics2d.VectorGraphics g2)
          Draws the handles of this box 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.
 java.lang.String[] getMultiText()
          Get multiline text
 int getPadX()
          Get pad ID in X
 int getPadY()
          Get pad ID in Y
 int getRotAngle()
          Returns the rotAngle property of this text object.
 java.awt.Color getShadowColor()
          Get color of shadow
 int getShadowXOffset()
          Get shadow offset in X
 int getShadowYOffset()
          Get shadow offset in Y
 java.lang.String getText()
          Returns the textString property of this text object.
 int getType()
          Get identification number for 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 isMultiline()
          Is this multiline text?
 boolean isShadow()
          Is box with shadow?
 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.
 void rescaleObject(int orx, int ory, float scale)
          Rescales this Label by the scale factor scale, keeping the point (orx, ory) fixed.
 void setFont(java.awt.Font font)
          Sets the textFont property of this text object.
 void setMultiText(java.lang.String[] multitext)
          Set multiline text
 void setPadX(int pad)
          Set pad ID in X
 void setPadY(int pad)
          Set pad ID in Y
 void setRotAngle(int angle)
          Sets the rotAngle property of this text object.
 void setShadow(boolean shadow)
          Sets the shadow to the box.
 void setShadowSize(int size)
          Sets a shadow size.
 void setShadowXOffset(int shadowXOffset)
          Set shadow offset in X
 void setShadowYOffset(int shadowYOffset)
          Set shadow offset in Y
 void setText(java.lang.String string)
          Sets the textString property of this text object.
 void setType(int type)
          Set identification number for this text object
 
Methods inherited from class jhplot.jadraw.JaFillObject
getFillColor, getStroke, latexWidth, setFillColor, setStroke
 
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

JaTextBox

public JaTextBox()
Constructor: sets the width, height, getRelw() and getRelh() to a default value of 25.

Method Detail

getType

public int getType()
Get identification number for this text object

Returns:
identification number

setType

public void setType(int type)
Set identification number for this text object

Parameters:
type - identification number

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

isShadow

public boolean isShadow()
Is box with shadow?

Returns:
true if multiline

isMultiline

public boolean isMultiline()
Is this multiline text?

Returns:
true if multiline

setMultiText

public void setMultiText(java.lang.String[] multitext)
Set multiline text

Parameters:
multitext - input text

getShadowColor

public java.awt.Color getShadowColor()
Get color of shadow

Returns:
color

getShadowXOffset

public int getShadowXOffset()
Get shadow offset in X

Returns:
offset

getShadowYOffset

public int getShadowYOffset()
Get shadow offset in Y

Returns:

setShadowXOffset

public void setShadowXOffset(int shadowXOffset)
Set shadow offset in X

Parameters:
shadowXOffset -

setShadowYOffset

public void setShadowYOffset(int shadowYOffset)
Set shadow offset in Y

Parameters:
shadowYOffset -

getMultiText

public java.lang.String[] getMultiText()
Get multiline text

Returns:
text

getFont

public final java.awt.Font getFont()
Returns the textFont property of this text object.

Returns:
The textFont property of this text object.

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.

setShadow

public final void setShadow(boolean shadow)
Sets the shadow to the box.

Parameters:
shadow - true if shadow is needed

setShadowSize

public final void setShadowSize(int size)
Sets a shadow size.

Parameters:
size - size in pixels

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.

Specified by:
copy in class JaObject
Returns:
A 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.

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.

drawHandles

public final void drawHandles(org.freehep.graphics2d.VectorGraphics g2)
Draws the handles of this box object.

Specified by:
drawHandles in class JaObject
Parameters:
g2 - The current graphics context.

jaxoDraw

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

Specified by:
jaxoDraw in class JaObject
Parameters:
g2 - The graphics context where the Label 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 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.

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.

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


jHepWork 2.1 (C) S.Chekanov