Documentation API of the 'jhplot.jadraw.JaTextBox' Java class
JaTextBox
jhplot.jadraw

Class JaTextBox

    • 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(String[] multitext)
        Set multiline text
        Parameters:
        multitext - input text
      • getShadowColor

        public 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 String[] getMultiText()
        Get multiline text
        Returns:
        text
      • getFont

        public final Font getFont()
        Returns the textFont property of this text object.
        Returns:
        The textFont property of this text object.
      • setFont

        public final void setFont(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 String getText()
        Returns the textString property of this text object.
        Returns:
        The textString property of this text object.
      • setText

        public final void setText(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 String latexCommand(float scale,                  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.

SCaVis 2.2 © jWork.ORG

Warning: You see this message because an access to the SCaVis documentation for third-party Java classes is denied. Guests can only view jhplot Java API. To enable the description of all Java classes of SCaVis, please request the full SCaVis membership.

If you are already a full member, please login to the SCaVis member area before visiting this documentation.