Unit Class

Unit Class

Most size-related generation properties are represented by the Unit class. A Unit stores one physical value and exposes conversions to other units.

Set values in pixels

generator.getParameters().getBarcode().getXDimension().setPixels(3.0f);
generator.getParameters().getBarcode().getBarHeight().setPixels(100);

Pixel values are direct raster measurements and do not scale when the output resolution changes.

Set values in physical units

generator.getParameters().setResolution(300.0f);
generator.getParameters().getBarcode().getXDimension()
        .setMillimeters(0.33f);
generator.getParameters().getBarcode().getBarHeight()
        .setMillimeters(15.0f);

Physical values are converted to pixels according to the current resolution. Use updateResolution when working with a standalone Unit object or when inspecting a conversion explicitly.

Unit unit = new Unit();
unit.updateResolution(300.0f);
unit.setInches(0.25f);
float pixels = unit.getPixels();

Supported measurements

Common setters include:

  • setPixels
  • setMillimeters
  • setInches
  • setPoint
  • setDocument

Use physical units for printer-oriented layouts and pixels for fixed raster assets. Do not mix a fixed physical X-dimension with an auto-size mode that recalculates module size.

Complete example

View UseUnitExample.java

set