PstricksFormatter.ParameterString (jPicEdt 1.4.1_03 API documentation)

java.lang.Object
- jpicedt.format.output.pstricks.PstricksFormatter.ParameterString

Enclosing class:

PstricksFormatter
```
public class PstricksFormatter.ParameterString
extends java.lang.Object
```
an inner class that represents a PsTricks parameter string (useful especially to handle User Defined Colours) the basic problem is that, if a new colour has to be defined, this has to be done through e.g. a \\newrgbcolor command BEFORE the Element command appears in the file. Hence it's necessary to return an object encapsulating several strings, not only the parameter string that appears inside the Element formated string.

Constructor Summary

Constructors
Constructor Description

ParameterString(java.lang.StringBuffer paramBuf, java.lang.StringBuffer userDefinedColourBuf)

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`java.lang.StringBuffer`	`getParameterBuffer()`
`java.lang.StringBuffer`	`getUserDefinedColourBuffer()`
`boolean`	`isDefinedColourString()`

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

- Constructor Detail
  - ParameterString
```
public ParameterString(java.lang.StringBuffer paramBuf,
                       java.lang.StringBuffer userDefinedColourBuf)
```
- Method Detail
  - isDefinedColourString
```
public boolean isDefinedColourString()
```
    Returns:
    
    true if there's at least one user-defined colour that need to be defined
  - getParameterBuffer
```
public java.lang.StringBuffer getParameterBuffer()
```
    Returns:
    
    the formated parameter string (w/o leading and trailing brackets)
  - getUserDefinedColourBuffer
```
public java.lang.StringBuffer getUserDefinedColourBuffer()
```
    Returns:
    
    a string containing \\newrgbcolor... like commands, separated by CR's, or an empty stringBuffer if there's no user-defined colours.