AbstractPageRangeStamper (adams-pom 24.5.0-SNAPSHOT API)

java.lang.Object
- adams.core.logging.LoggingObject
- - adams.core.logging.CustomLoggingLevelObject
  - - adams.core.option.AbstractOptionHandler
    - - adams.flow.transformer.pdfstamp.AbstractStamper
      - adams.flow.transformer.pdfstamp.AbstractPageRangeStamper

All Implemented Interfaces:

Destroyable, GlobalInfoSupporter, LoggingLevelHandler, LoggingSupporter, OptionHandler, SizeOfHandler, Serializable

Direct Known Subclasses:

Image, Text
```
public abstract class AbstractPageRangeStamper
extends AbstractStamper
```
Ancestor for stampers that work on a range of pages.

Version:

$Revision$

Author:

FracPete (fracpete at waikato dot ac dot nz)

See Also:

Serialized Form

Field Summary

Fields
Modifier and Type Field Description

protected Range m_Pages
the page range to work on.
- Fields inherited from class adams.core.option.AbstractOptionHandler
  m_OptionManager
- Fields inherited from class adams.core.logging.LoggingObject
  m_Logger, m_LoggingIsEnabled, m_LoggingLevel

Constructor Summary

Constructors
Constructor Description

AbstractPageRangeStamper()

Method Summary

All Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method	Description
`void`	`defineOptions()`	Adds options to the internal list of options.
`protected void`	`doStamp(com.itextpdf.text.pdf.PdfStamper stamper)`	Performs the actual stamping.
`protected abstract void`	`doStamp(com.itextpdf.text.pdf.PdfStamper stamper, int page)`	Performs the actual stamping.
`Range`	`getPages()`	Returns the page range.
`String`	`pagesTipText()`	Returns the tip text for this property.
`void`	`setPages(Range value)`	Sets the page range.

Methods inherited from class adams.flow.transformer.pdfstamp.AbstractStamper
check, stamp

Methods inherited from class adams.core.option.AbstractOptionHandler
cleanUpOptions, destroy, finishInit, getDefaultLoggingLevel, getOptionManager, globalInfo, initialize, loggingLevelTipText, newOptionManager, reset, setLoggingLevel, toCommandLine, toString

Methods inherited from class adams.core.logging.LoggingObject
configureLogger, getLogger, getLoggingLevel, initializeLogging, isLoggingEnabled, sizeOf

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

Methods inherited from interface adams.core.logging.LoggingLevelHandler
getLoggingLevel

- Field Detail
  - m_Pages
```
protected Range m_Pages
```
    the page range to work on.
- Constructor Detail
  - AbstractPageRangeStamper
```
public AbstractPageRangeStamper()
```
- Method Detail
  - defineOptions
```
public void defineOptions()
```
    Adds options to the internal list of options.
    
    Specified by:
    
    defineOptions in interface OptionHandler
    
    Overrides:
    
    defineOptions in class AbstractOptionHandler
  - setPages
```
public void setPages(Range value)
```
    Sets the page range.
    
    Parameters:
    
    value - the page range
  - getPages
```
public Range getPages()
```
    Returns the page range.
    
    Returns:
    
    the page range
  - pagesTipText
```
public String pagesTipText()
```
    Returns the tip text for this property.
    
    Returns:
    
    tip text for this property suitable for displaying in the GUI or for listing the options.
  - doStamp
```
protected abstract void doStamp(com.itextpdf.text.pdf.PdfStamper stamper,
                                int page)
```
    Performs the actual stamping.
    
    Parameters:
    
    stamper - the stamper to use
    
    page - the page to apply the stamp to
  - doStamp
```
protected void doStamp(com.itextpdf.text.pdf.PdfStamper stamper)
```
    Performs the actual stamping.
    
    Specified by:
    
    doStamp in class AbstractStamper
    
    Parameters:
    
    stamper - the stamper to use