10
Modifying the User Interface
Working with PDF Layers
Editing the Properties of PDF Layers
The
OCG
object provides properties that can be used to determine whether the object’s
default state should be on or off, whether its intent should be for viewing or design
purposes, whether it should be locked, the text string seen in the user interface, and the
current state. The properties are shown below in
Table 10.15:
T
ABLE
10.15
OCG Properties
Property
Description
Determines whether the
OCG
object is on or off by
default
The intent of the
OCG
object (View or Design)
Whether the on/off state can be toggled through the user
interface
The text string seen in the user interface for the
OCG
object
The current on/off state of the
OCG
object
initState
intent
locked
name
state
The
initState
property can be used to set the default state for an optional content
group. In the following example,
myLayer
is set to
on
by default:
myLayer.initState = true;
The
intent
property, which is an array of values, can be used to define the intent of a
particular optional content group. There are two possible values used in the array:
View
and
Design
. A
Design
layer is created for informational purposes only, and does not
affect the visibility of content. Its purpose is to represent a document designer’s structural
organization of artwork. The
View
layer is intended for interactive use by document
consumers. If
View
is used, the visibility of the layer is affected. In the following example,
the intent of all the
OCG
objects in the document is set to both values:
var ocgs = this.getOCGs();
for (var i=0; i<ocgs.length; i++)
ocgs[i].intent = ["View", "Design"];
The
locked
property is used to determine whether a given layer can be toggled through
the user interface. In the following example,
myLayer
is locked, meaning that it cannot be
toggled through the user interface:
myLayer.locked = true;
The
state
property represents the current on/off state for a given OCG. In the following
example, all the OCGs are turned on:
var ocgs = this.getOCGs();
for (var i=0; i<ocgs.length; i++)
ocgs[i].state = true;
188
Acrobat JavaScript Scripting Guide
Pages: Index 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280