Skip to content

Commit 08c7325

Browse files
committed
Improve javadoc of xfdf object classes.
DEVSIX-3385
1 parent 3155969 commit 08c7325

20 files changed

+792
-92
lines changed

forms/src/main/java/com/itextpdf/forms/xfdf/ActionObject.java

Lines changed: 62 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -55,22 +55,23 @@ public class ActionObject {
5555

5656

5757
/**
58-
* Type of inner action element. Possible values: URI, Launch, GoTo, GoToR, Named.
58+
* Type of inner action element. Possible values: {@link PdfName#URI}, {@link PdfName#Launch}, {@link PdfName#GoTo},
59+
* {@link PdfName#GoToR}, {@link PdfName#Named}.
5960
*/
6061
private PdfName type;
6162

6263
/**
63-
* Represents Name required attribute of URI element. For more details see paragraph 6.5.30 in Xfdf specification.
64+
* Represents Name, required attribute of URI element. For more details see paragraph 6.5.30 in Xfdf specification.
6465
*/
6566
private PdfString uri;
6667

6768
/**
68-
* Represents IsMap optional attribute of URI element. For more details see paragraph 6.5.30 in Xfdf specification.
69+
* Represents IsMap, optional attribute of URI element. For more details see paragraph 6.5.30 in Xfdf specification.
6970
*/
7071
private boolean isMap;
7172

7273
/**
73-
* Represents Name required attribute of Named element. For more details see paragraph 6.5.24 in Xfdf specification.
74+
* Represents Name, required attribute of Named element. For more details see paragraph 6.5.24 in Xfdf specification.
7475
*/
7576
private PdfName nameAction;
7677

@@ -82,12 +83,12 @@ public class ActionObject {
8283
private String fileOriginalName;
8384

8485
/**
85-
* Represents NewWindows optional attribute of Launch element. For more details see paragraph 6.5.23 in Xfdf specification.
86+
* Represents NewWindow, optional attribute of Launch element. For more details see paragraph 6.5.23 in Xfdf specification.
8687
*/
8788
private boolean isNewWindow;
8889

8990
/**
90-
* Represents Dest inner element of link, GoTo, and GoToR elements.
91+
* Represents Dest, inner element of link, GoTo, and GoToR elements.
9192
* Corresponds to Dest key in link annotation dictionary.
9293
* For more details see paragraph 6.5.10 in Xfdf specification.
9394
*/
@@ -97,64 +98,119 @@ public ActionObject(PdfName type) {
9798
this.type = type;
9899
}
99100

101+
102+
/**
103+
* Returns the type of inner action element. Possible values: {@link PdfName#URI}, {@link PdfName#Launch},
104+
* {@link PdfName#GoTo}, {@link PdfName#GoToR}, {@link PdfName#Named}.
105+
*/
100106
public PdfName getType() {
101107
return type;
102108
}
103109

110+
/**
111+
* Sets the type of inner action element. Possible values: {@link PdfName#URI}, {@link PdfName#Launch},
112+
* {@link PdfName#GoTo}, {@link PdfName#GoToR}, {@link PdfName#Named}.
113+
*/
104114
public ActionObject setType(PdfName type) {
105115
this.type = type;
106116
return this;
107117
}
108118

119+
/**
120+
* Gets the string value of URI elements. Corresponds to Name, required attribute of URI element.
121+
* For more details see paragraph 6.5.30 in Xfdf specification.
122+
*/
109123
public PdfString getUri() {
110124
return uri;
111125
}
112126

127+
/**
128+
* Sets the string value of URI elements. Corresponds to Name, required attribute of URI element.
129+
* For more details see paragraph 6.5.30 in Xfdf specification.
130+
*/
113131
public ActionObject setUri(PdfString uri) {
114132
this.uri = uri;
115133
return this;
116134
}
117135

136+
/**
137+
* Gets IsMap, optional attribute of URI element. For more details see paragraph 6.5.30 in Xfdf specification.
138+
*/
118139
public boolean isMap() {
119140
return isMap;
120141
}
121142

143+
/**
144+
* Sets IsMap, optional attribute of URI element. For more details see paragraph 6.5.30 in Xfdf specification.
145+
*/
122146
public ActionObject setMap(boolean map) {
123147
isMap = map;
124148
return this;
125149
}
126150

151+
/**
152+
* Gets the value of Name, required attribute of Named element. For more details see paragraph 6.5.24 in Xfdf specification.
153+
*/
127154
public PdfName getNameAction() {
128155
return nameAction;
129156
}
130157

158+
/**
159+
* Sets the value of Name, required attribute of Named element. For more details see paragraph 6.5.24 in Xfdf specification.
160+
*/
131161
public ActionObject setNameAction(PdfName nameAction) {
132162
this.nameAction = nameAction;
133163
return this;
134164
}
135165

166+
/**
167+
* Gets the string value of OriginalName, required attribute of File inner element of GoToR or Launch element.
168+
* Corresponds to F key in go-to action or launch dictionaries.
169+
* For more details see paragraphs 6.5.11, 6.5.23 in Xfdf specification.
170+
*/
136171
public String getFileOriginalName() {
137172
return fileOriginalName;
138173
}
139174

175+
/**
176+
* Sets the string value of OriginalName, required attribute of File inner element of GoToR or Launch element.
177+
* Corresponds to F key in go-to action or launch dictionaries.
178+
* For more details see paragraphs 6.5.11, 6.5.23 in Xfdf specification.
179+
*/
140180
public ActionObject setFileOriginalName(String fileOriginalName) {
141181
this.fileOriginalName = fileOriginalName;
142182
return this;
143183
}
144184

185+
/**
186+
* Sets the boolean value of NewWindow, optional attribute of Launch element. For more details see paragraph 6.5.23 in Xfdf specification.
187+
*/
145188
public boolean isNewWindow() {
146189
return isNewWindow;
147190
}
148191

192+
/**
193+
* Gets the boolean value of NewWindow, optional attribute of Launch element. For more details see paragraph 6.5.23 in Xfdf specification.
194+
*/
149195
public ActionObject setNewWindow(boolean newWindow) {
150196
isNewWindow = newWindow;
151197
return this;
152198
}
153199

200+
/**
201+
* Gets Dest, inner element of link, GoTo, and GoToR elements.
202+
* Corresponds to Dest key in link annotation dictionary.
203+
* For more details see paragraph 6.5.10 in Xfdf specification.
204+
*/
154205
public DestObject getDestination() {
155206
return destination;
156207
}
157208

209+
/**
210+
* Sets Dest, inner element of link, GoTo, and GoToR elements.
211+
* Corresponds to Dest key in link annotation dictionary.
212+
* For more details see paragraph 6.5.10 in Xfdf specification.
213+
*/
158214
public ActionObject setDestination(DestObject destination) {
159215
this.destination = destination;
160216
return this;

0 commit comments

Comments
 (0)