org.icepdf.core.pobjects.annotations
Class BorderEffect

java.lang.Object
  org.icepdf.core.pobjects.Dictionary
      org.icepdf.core.pobjects.annotations.BorderEffect

public class BorderEffect
extends Dictionary

Refer to: 8.4.3 Border Styles

Key

Type

Value

S

name

(Optional) A name representing the border effect to apply. Possible values are:

S	No effect: the border is as described by the annotation dictionary's BS entry.
C	The border should appear "cloudy". The width and dash array specified by BS are honored.

Default value: S.

I

number

(Optional; valid only if the value of S is C) A number describing the intensity of the effect. Suggested values range from 0 to 2. Default value: 0.

Since:

2.5

Author:

Mark Collette

Field Summary

Fields inherited from class org.icepdf.core.pobjects.Dictionary

entries, FORM_TYPE_KEY, inited, isDeleted, isNew, LENGTH_KEY, library, SUBTYPE_KEY, TYPE_KEY

Constructor Summary

BorderEffect(Library l, java.util.HashMap h)
Creates a new instance of a BorderEffect.

Method Summary

Methods inherited from class org.icepdf.core.pobjects.Dictionary

getEntries, getFloat, getInt, getLibrary, getNumber, getObject, getPObjectReference, init, isDeleted, isNew, setDeleted, setNew, setPObjectReference, toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

BorderEffect

public BorderEffect(Library l,
                    java.util.HashMap h)

Creates a new instance of a BorderEffect.

Parameters:

l - document library.

h - dictionary entries.