PsBox (jPicEdt 1.4.1_03 API documentation)

java.lang.Object
- jpicedt.format.input.util.AbstractRegularExpression
- - jpicedt.format.input.util.SequenceExpression
  - - jpicedt.format.input.pstricks.PsBox

All Implemented Interfaces:

ExpressionConstants, PicObjectConstants
```
public class PsBox
extends SequenceExpression
implements PicObjectConstants, ExpressionConstants
```
Parses PsTricks boxes, i.e. (depending on the "type" parameter of the constructor)
- \\psframebox[param]{text}}
- \\psovalbox[param]{text}}
- \\pscirclebox[param]{text}}
This expression is to be used as a child expression of either {@link #jpicedt.format.input.latex.LaTeXPutExpression jpicedt.format.input.latex.LaTeXPutExpression} or {@link #jpicedt.format.input.pstricks.PsRPutExpression PsRPutExpression}.
The parsing code makes use of the following Pool's key/value pairs (as set by the enclosing XXXPutExpression beforehands):
- KEY_RPUT_VALIGN: \\rput's [bBt] vertical alignment parameter
- KEY_RPUT_HALIGN: \\rput's [lr] horizontal alignment parameter
- KEY_RPUT_POINT: \\rput's (x,y) KEY_RPUT_VALIGNparameter
- KEY_RPUT_ROTATION: \\rput's {rotation} parameter
For each of these four keys, permitted values are the same as in PicAttributeSet. For instance, the value associated with KEY_RPUT_VALIGN may be TEXT_VALIGN_BOTTOM, TEXT_VALIGN_BASELINE, ...
Since:

jpicedt 1.4pre2

Version:

$Id: PsBox.java,v 1.3.2.1 2007/09/02 11:56:12 reynal Exp $

Author:

Sylvain Reynal

Field Summary

Fields
Modifier and Type	Field	Description
`static java.lang.String`	`CIRCLE_BOX`	expects a \\pscirclebox macro
`static java.lang.String`	`OVAL_BOX`	expects a \\psovalbox macro
`static java.lang.String`	`RECTANGLE_BOX`	expects a \\psframebox macro

Fields inherited from interface jpicedt.format.input.util.ExpressionConstants
ANY_CHAR, ANY_CHAR_EOL, ANY_SIGN, AT_LEAST, AT_MOST, DEBUG, DOUBLE, EOL, EXACTLY, INTEGER, NEGATIVE, NON_NULL, POSITIVE, STRICTLY_NEGATIVE, STRICTLY_POSITIVE, WHITE_SPACES, WHITE_SPACES_OR_EOL

Fields inherited from interface jpicedt.graphic.model.PicObjectConstants
ARROW_GLOBAL_SCALE_LENGTH, ARROW_GLOBAL_SCALE_WIDTH, ARROW_INSET_SCALE, ARROW_LENGTH_SCALE, ARROW_WIDTH_LINEWIDTH_SCALE, ARROW_WIDTH_MINIMUM_MM, BRACKET_LENGTH_SCALE, CROSSHATCH, CROSSHATCH_FILLED, DASH_OPAQUE, DASH_TRANSPARENT, DASH1, DASH2, DASH3, DASHED, DIMEN, DOT_SEP, DOT_SEP1, DOT_SEP2, DOT_SEP3, DOTTED, DOUBLE_COLOR, DOUBLE_LINE, DOUBLE_SEP, FILL_COLOR, FILL_STYLE, HATCH_ANGLE, HATCH_COLOR, HATCH_SEP, HATCH_WIDTH, HLINES, HLINES_FILLED, INNER, LEFT_ARROW, LINE_COLOR, LINE_STYLE, LINE_WIDTH, MIDDLE, NONE, OUTER, OVER_STRIKE, OVER_STRIKE_COLOR, OVER_STRIKE_WIDTH, POLYDOTS_ANGLE, POLYDOTS_CIRCLE, POLYDOTS_DISK, POLYDOTS_PENTAGON, POLYDOTS_PENTAGON_FILLED, POLYDOTS_PLUS, POLYDOTS_SCALE_H, POLYDOTS_SCALE_V, POLYDOTS_SIZE_LINEWIDTH_SCALE, POLYDOTS_SIZE_MINIMUM_MM, POLYDOTS_SQUARE, POLYDOTS_SQUARE_FILLED, POLYDOTS_STYLE, POLYDOTS_SUPERIMPOSE, POLYDOTS_TRIANGLE, POLYDOTS_TRIANGLE_FILLED, PS_POINT, PST_CUSTOM, RBRACKET_LENGTH_SCALE, RIGHT_ARROW, SHADOW, SHADOW_ANGLE, SHADOW_COLOR, SHADOW_SIZE, SOLID, TBAR_WIDTH_LINEWIDTH_SCALE, TBAR_WIDTH_MINIMUM_MM, TEXT_BOX_CIRCLE, TEXT_BOX_NO_FRAME, TEXT_BOX_OVAL, TEXT_BOX_RECTANGLE, TEXT_FRAME, TEXT_HALIGN_CENTER, TEXT_HALIGN_LEFT, TEXT_HALIGN_RIGHT, TEXT_HOR_ALIGN, TEXT_ROTATION, TEXT_VALIGN_BASELINE, TEXT_VALIGN_BOTTOM, TEXT_VALIGN_CENTER, TEXT_VALIGN_TOP, TEXT_VERT_ALIGN, VLINES, VLINES_FILLED

Constructor Summary

Constructors
Constructor Description

PsBox(Pool pl, java.lang.String type)

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`void`	`action(ParserEvent e)`	Called in the course of the interpret operation at the end of a SUCCESSFUL interpret operation.

Methods inherited from class jpicedt.format.input.util.SequenceExpression
add, interpret, toString

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Field Detail
  - RECTANGLE_BOX
```
public static final java.lang.String RECTANGLE_BOX
```
    expects a \\psframebox macro
    
    See Also:
    
    Constant Field Values
  - CIRCLE_BOX
```
public static final java.lang.String CIRCLE_BOX
```
    expects a \\pscirclebox macro
    
    See Also:
    
    Constant Field Values
  - OVAL_BOX
```
public static final java.lang.String OVAL_BOX
```
    expects a \\psovalbox macro
    
    See Also:
    
    Constant Field Values
- Constructor Detail
  - PsBox
```
public PsBox(Pool pl,
             java.lang.String type)
```
    Parameters:
    
    type - RECTANGLE_BOX, CIRCLE_BOX or OVAL_BOX depending on the expected box type.
- Method Detail
  - action
```
public void action(ParserEvent e)
```
    Description copied from class: AbstractRegularExpression
    
    Called in the course of the interpret operation at the end of a SUCCESSFUL interpret operation. Should be overriden by daughter classes to process proper action, e.g. set Element's attributes... Current implementation does nothing, but sending a debugging string.
    
    Overrides:
    
    action in class AbstractRegularExpression