Format (CloudPOSSDK)

java.lang.Object
- com.cloudpos.printer.Format

```
public class Format
extends java.lang.Object
```
Represents printing formats for characters, images, and barcodes.

Field Summary

Fields
Modifier and Type	Field and Description
`static java.lang.String`	`FORMAT_ALIGN`
`static java.lang.String`	`FORMAT_ALIGN_CENTER`
`static java.lang.String`	`FORMAT_ALIGN_LEFT`
`static java.lang.String`	`FORMAT_ALIGN_RIGHT`
`static java.lang.String`	`FORMAT_BARCODE_HRILOCATION`
`static java.lang.String`	`FORMAT_BARCODE_HRILOCATION_DOWN`
`static java.lang.String`	`FORMAT_BARCODE_HRILOCATION_NONE`
`static java.lang.String`	`FORMAT_BARCODE_HRILOCATION_UP`
`static java.lang.String`	`FORMAT_BARCODE_HRILOCATION_UPDOWN`
`static java.lang.String`	`FORMAT_DENSITY`
`static java.lang.String`	`FORMAT_DENSITY_DARK`
`static java.lang.String`	`FORMAT_DENSITY_LIGHT`
`static java.lang.String`	`FORMAT_DENSITY_MEDIUM`
`static java.lang.String`	`FORMAT_FONT_BOLD`
`static java.lang.String`	`FORMAT_FONT_INVERSION`
`static java.lang.String`	`FORMAT_FONT_ITALIC`
`static java.lang.String`	`FORMAT_FONT_LINETHROUGH`
`static java.lang.String`	`FORMAT_FONT_REVERSE`
`static java.lang.String`	`FORMAT_FONT_SIZE`
`static java.lang.String`	`FORMAT_FONT_SIZE_EXTRALARGE`
`static java.lang.String`	`FORMAT_FONT_SIZE_EXTRASMALL`
`static java.lang.String`	`FORMAT_FONT_SIZE_LARGE`
`static java.lang.String`	`FORMAT_FONT_SIZE_MEDIUM`
`static java.lang.String`	`FORMAT_FONT_SIZE_SMALL`
`static java.lang.String`	`FORMAT_FONT_VAL_FALSE`
`static java.lang.String`	`FORMAT_FONT_VAL_TRUE`

Constructor Summary

Constructors
Constructor and Description

Format()
Constructs a new Format instance with default settings.

Constructors
Constructor and Description
`Format()` Constructs a new Format instance with default settings.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`clear()` Clears all format parameters.
`java.lang.String`	`getParameter(java.lang.String key)` Retrieves the value of a specified format parameter.
`void`	`remove(java.lang.String key)` Removes a specific format parameter.
`void`	`setParameter(java.lang.String key, java.lang.String value)` Sets a printing format parameter with the specified key and value.
`java.lang.String`	`toString()`

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

- Field Detail
  - FORMAT_DENSITY
```
public static final java.lang.String FORMAT_DENSITY
```
    See Also:
    
    Constant Field Values
  - FORMAT_DENSITY_LIGHT
```
public static final java.lang.String FORMAT_DENSITY_LIGHT
```
    See Also:
    
    Constant Field Values
  - FORMAT_DENSITY_MEDIUM
```
public static final java.lang.String FORMAT_DENSITY_MEDIUM
```
    See Also:
    
    Constant Field Values
  - FORMAT_DENSITY_DARK
```
public static final java.lang.String FORMAT_DENSITY_DARK
```
    See Also:
    
    Constant Field Values
  - FORMAT_FONT_BOLD
```
public static final java.lang.String FORMAT_FONT_BOLD
```
    See Also:
    
    Constant Field Values
  - FORMAT_FONT_REVERSE
```
public static final java.lang.String FORMAT_FONT_REVERSE
```
    See Also:
    
    Constant Field Values
  - FORMAT_FONT_INVERSION
```
public static final java.lang.String FORMAT_FONT_INVERSION
```
    See Also:
    
    Constant Field Values
  - FORMAT_FONT_LINETHROUGH
```
public static final java.lang.String FORMAT_FONT_LINETHROUGH
```
    See Also:
    
    Constant Field Values
  - FORMAT_FONT_ITALIC
```
public static final java.lang.String FORMAT_FONT_ITALIC
```
    See Also:
    
    Constant Field Values
  - FORMAT_FONT_VAL_TRUE
```
public static final java.lang.String FORMAT_FONT_VAL_TRUE
```
    See Also:
    
    Constant Field Values
  - FORMAT_FONT_VAL_FALSE
```
public static final java.lang.String FORMAT_FONT_VAL_FALSE
```
    See Also:
    
    Constant Field Values
  - FORMAT_FONT_SIZE
```
public static final java.lang.String FORMAT_FONT_SIZE
```
    See Also:
    
    Constant Field Values
  - FORMAT_FONT_SIZE_EXTRASMALL
```
public static final java.lang.String FORMAT_FONT_SIZE_EXTRASMALL
```
    See Also:
    
    Constant Field Values
  - FORMAT_FONT_SIZE_SMALL
```
public static final java.lang.String FORMAT_FONT_SIZE_SMALL
```
    See Also:
    
    Constant Field Values
  - FORMAT_FONT_SIZE_MEDIUM
```
public static final java.lang.String FORMAT_FONT_SIZE_MEDIUM
```
    See Also:
    
    Constant Field Values
  - FORMAT_FONT_SIZE_LARGE
```
public static final java.lang.String FORMAT_FONT_SIZE_LARGE
```
    See Also:
    
    Constant Field Values
  - FORMAT_FONT_SIZE_EXTRALARGE
```
public static final java.lang.String FORMAT_FONT_SIZE_EXTRALARGE
```
    See Also:
    
    Constant Field Values
  - FORMAT_ALIGN
```
public static final java.lang.String FORMAT_ALIGN
```
    See Also:
    
    Constant Field Values
  - FORMAT_ALIGN_LEFT
```
public static final java.lang.String FORMAT_ALIGN_LEFT
```
    See Also:
    
    Constant Field Values
  - FORMAT_ALIGN_RIGHT
```
public static final java.lang.String FORMAT_ALIGN_RIGHT
```
    See Also:
    
    Constant Field Values
  - FORMAT_ALIGN_CENTER
```
public static final java.lang.String FORMAT_ALIGN_CENTER
```
    See Also:
    
    Constant Field Values
  - FORMAT_BARCODE_HRILOCATION
```
public static final java.lang.String FORMAT_BARCODE_HRILOCATION
```
    See Also:
    
    Constant Field Values
  - FORMAT_BARCODE_HRILOCATION_NONE
```
public static final java.lang.String FORMAT_BARCODE_HRILOCATION_NONE
```
    See Also:
    
    Constant Field Values
  - FORMAT_BARCODE_HRILOCATION_UP
```
public static final java.lang.String FORMAT_BARCODE_HRILOCATION_UP
```
    See Also:
    
    Constant Field Values
  - FORMAT_BARCODE_HRILOCATION_DOWN
```
public static final java.lang.String FORMAT_BARCODE_HRILOCATION_DOWN
```
    See Also:
    
    Constant Field Values
  - FORMAT_BARCODE_HRILOCATION_UPDOWN
```
public static final java.lang.String FORMAT_BARCODE_HRILOCATION_UPDOWN
```
    See Also:
    
    Constant Field Values
- Constructor Detail
  - Format
```
public Format()
```
    Constructs a new Format instance with default settings.
- Method Detail
  - toString
```
public java.lang.String toString()
```
    Overrides:
    
    toString in class java.lang.Object
  - setParameter
```
public void setParameter(java.lang.String key,
                         java.lang.String value)
```
    Sets a printing format parameter with the specified key and value.
    Available format options include:
    - 'density': Can be 'light', 'medium', 'dark'. Affects character, image, and barcode rendering.
    - 'bold': Can be 'true' or 'false'. Applies bold formatting to characters.
    - 'reverse': Can be 'true' or 'false'. Applies reverse formatting to characters.
    - 'inversion': Can be 'true' or 'false'. Inverts the color of characters.
    - 'line-through': Can be '1' (continuous) or '2' (disconnected). Applies a line-through effect to characters.
    - 'size': Can be 'extra-small', 'small', 'medium', 'large', 'extra-large'. Sets the font size for characters.
    - 'align': Can be 'left', 'right', 'center'. Sets the alignment for characters and images.
    - 'italic': Can be 'true' or 'false'. Applies italic formatting to characters.
    - 'HRI-location': Can be 'none' (not printed), 'up' (above the barcode), 'down' (below the barcode), or 'up-down' (both above and below the barcode). Specifies the location of Human Readable Interpretation (HRI) for barcodes.
    Note: Setting a parameter that does not match the key's expected value range will have no effect.
    Parameters:
    
    key - The format parameter key.
    
    value - The value for the specified format parameter.
  - getParameter
```
public java.lang.String getParameter(java.lang.String key)
```
    Retrieves the value of a specified format parameter.
    
    Parameters:
    
    key - The key of the format parameter to retrieve.
    
    Returns:
    
    The value of the specified format parameter, or null if not set.
  - remove
```
public void remove(java.lang.String key)
```
    Removes a specific format parameter.
    
    Parameters:
    
    key - The key of the format parameter to be removed.
  - clear
```
public void clear()
```
    Clears all format parameters.

Class Format

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

FORMAT_DENSITY

FORMAT_DENSITY_LIGHT

FORMAT_DENSITY_MEDIUM

FORMAT_DENSITY_DARK

FORMAT_FONT_BOLD

FORMAT_FONT_REVERSE

FORMAT_FONT_INVERSION

FORMAT_FONT_LINETHROUGH

FORMAT_FONT_ITALIC

FORMAT_FONT_VAL_TRUE

FORMAT_FONT_VAL_FALSE

FORMAT_FONT_SIZE

FORMAT_FONT_SIZE_EXTRASMALL

FORMAT_FONT_SIZE_SMALL

FORMAT_FONT_SIZE_MEDIUM

FORMAT_FONT_SIZE_LARGE

FORMAT_FONT_SIZE_EXTRALARGE

FORMAT_ALIGN

FORMAT_ALIGN_LEFT

FORMAT_ALIGN_RIGHT

FORMAT_ALIGN_CENTER

FORMAT_BARCODE_HRILOCATION

FORMAT_BARCODE_HRILOCATION_NONE

FORMAT_BARCODE_HRILOCATION_UP

FORMAT_BARCODE_HRILOCATION_DOWN

FORMAT_BARCODE_HRILOCATION_UPDOWN

Constructor Detail

Format

Method Detail

toString

setParameter

getParameter

remove

clear