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.interaction.actions
Class ToggleVisibility

    java.lang.Object
      org.pdfclown.objects.PdfObjectWrapper<PdfDictionary>
          org.pdfclown.documents.interaction.actions.Action
              org.pdfclown.documents.interaction.actions.ToggleVisibility

All Implemented Interfaces:
  Cloneable, IPdfObjectWrapper

    @PDF(value=PDF12)
    public final class ToggleVisibility

extends Action

'Toggle the visibility of one or more annotations on the screen' action [PDF:1.6:8.5.3].

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

Constructor Summary
`ToggleVisibility(Document context, Collection<PdfObjectWrapper<?>> objects, boolean visible)` Creates a new action within the given document context.

Method Summary
`ToggleVisibility` | `clone(Document context)` Gets a clone of the object, registered inside the given document context.
`Collection<PdfObjectWrapper<?>>` | `getObjects()` Gets the annotations (or associated form fields) to be affected.
`boolean` | `isVisible()` Gets whether to show the annotations.
`void` | `setObjects(Collection<PdfObjectWrapper<?>> value)`
`void` | `setVisible(boolean value)`

Methods inherited from class org.pdfclown.documents.interaction.actions.Action
`getActions, setActions, wrap`

Methods inherited from class org.pdfclown.objects.PdfObjectWrapper
`checkCompatibility, 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

### ToggleVisibility

    public ToggleVisibility(Document context,
                            Collection<PdfObjectWrapper<?>> objects,
                            boolean visible)

  Creates a new action within the given document context.

Method Detail

### clone

    public ToggleVisibility clone(Document context)

  Description copied from class: `PdfObjectWrapper`
  Gets a clone of the object, registered inside the given document context.

  Overrides:
    `clone` in class `Action`
  Parameters:
    `context` - Which document the clone has to be registered in.

### getObjects

    public Collection<PdfObjectWrapper<?>> getObjects()

  Gets the annotations (or associated form fields) to be affected.

### isVisible

    public boolean isVisible()

  Gets whether to show the annotations.

### setObjects

    public void setObjects(Collection<PdfObjectWrapper<?>> value)

  See Also:
    `getObjects()`

### setVisible

    public void setVisible(boolean value)

  See Also:
    `isVisible()`

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.