Overview | Package | Class | Use | Tree | Deprecated | Index | Help
| PDF Clown 0.1.2
PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD

## org.pdfclown.documents.contents.xObjects
Class XObject

    java.lang.Object
      org.pdfclown.objects.PdfObjectWrapper<PdfStream>
          org.pdfclown.documents.contents.xObjects.XObject

All Implemented Interfaces:
  Cloneable, ILayerable, IPdfObjectWrapper

Direct Known Subclasses:
  FormXObject, ImageXObject

    @PDF(value=PDF10)
    public abstract class XObject

extends PdfObjectWrapper<PdfStream>
implements ILayerable

External graphics object whose contents are defined by a self-contained content stream, separate from the content stream in which it is used [PDF:1.6:4.7].

Version:
  0.1.2, 12/28/12
Author:
  Stefano Chizzolini (http://www.stefanochizzolini.it)

Constructor Summary
`protected` | `XObject(Document context)` Creates a new external object inside the document.
`protected` | `XObject(Document context, PdfStream baseDataObject)` Creates a new external object inside the document.
`protected` | `XObject(PdfDirectObject baseObject)` Instantiates an existing external object.

Method Summary
`LayerEntity` | `getLayer()` Gets the layer entity associated to this object.
`abstract AffineTransform` | `getMatrix()` Gets the mapping from external-object space to user space.
`abstract Dimension2D` | `getSize()` Gets the external object size.
`void` | `setLayer(LayerEntity value)`
`abstract void` | `setMatrix(AffineTransform value)`
`abstract void` | `setSize(Dimension2D value)`
`static XObject` | `wrap(PdfDirectObject baseObject)` Wraps an external object reference into an external object.

Methods inherited from class org.pdfclown.objects.PdfObjectWrapper
`checkCompatibility, clone, delete, equals, exists, getBaseDataObject, getBaseObject, getBaseObject, getContainer, getDataContainer, getDocument, getFile, getMetadata, retrieveName, retrieveNamedBaseObject, setBaseObject, setMetadata`

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

Constructor Detail

### XObject

    protected XObject(Document context)

  Creates a new external object inside the document.

### XObject

    protected XObject(Document context,
                      PdfStream baseDataObject)

  Creates a new external object inside the document.

### XObject

    protected XObject(PdfDirectObject baseObject)

  Instantiates an existing external object.

Method Detail

### wrap

    public static XObject wrap(PdfDirectObject baseObject)

  Wraps an external object reference into an external object.

  Parameters:
    `baseObject` - External object base object.
  Returns:
    External object associated to the reference.

### getMatrix

    public abstract AffineTransform getMatrix()

  Gets the mapping from external-object space to user space.

### getSize

    public abstract Dimension2D getSize()

  Gets the external object size.

### setMatrix

    public abstract void setMatrix(AffineTransform value)

  See Also:
    `getMatrix()`

### setSize

    public abstract void setSize(Dimension2D value)

  See Also:
    `getSize()`

### getLayer

    @PDF(value=PDF15)
    public LayerEntity getLayer()

  Description copied from interface: `ILayerable`
  Gets the layer entity associated to this object.

  Specified by:
    `getLayer` in interface `ILayerable`

### setLayer

    public void setLayer(LayerEntity value)

  Specified by:
    `setLayer` in interface `ILayerable`
  See Also:
    `ILayerable.getLayer()`

Overview | Package | Class | Use | Tree | Deprecated | Index | Help
| PDF Clown 0.1.2
PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD

Project home page
Copyright © 2006-2013 Stefano Chizzolini. Some Rights Reserved.
This documentation is available under the terms of the GNU Free Documentation License.