Skip to content

Commit 7a8adab

Browse files
committed
Improve javadoc of xfdf object classes.
DEVSIX-3385 Autoported commit. Original commit hash: [08c732522] Manual files: forms/src/main/java/com/itextpdf/forms/xfdf/XfdfFileUtils.java
1 parent b3002c7 commit 7a8adab

21 files changed

+923
-98
lines changed

itext/itext.forms/itext/forms/xfdf/ActionObject.cs

Lines changed: 102 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -53,21 +53,32 @@ namespace iText.Forms.Xfdf {
5353
/// </remarks>
5454
public class ActionObject {
5555
/// <summary>Type of inner action element.</summary>
56-
/// <remarks>Type of inner action element. Possible values: URI, Launch, GoTo, GoToR, Named.</remarks>
56+
/// <remarks>
57+
/// Type of inner action element. Possible values:
58+
/// <see cref="iText.Kernel.Pdf.PdfName.URI"/>
59+
/// ,
60+
/// <see cref="iText.Kernel.Pdf.PdfName.Launch"/>
61+
/// ,
62+
/// <see cref="iText.Kernel.Pdf.PdfName.GoTo"/>
63+
/// ,
64+
/// <see cref="iText.Kernel.Pdf.PdfName.GoToR"/>
65+
/// ,
66+
/// <see cref="iText.Kernel.Pdf.PdfName.Named"/>.
67+
/// </remarks>
5768
private PdfName type;
5869

59-
/// <summary>Represents Name required attribute of URI element.</summary>
60-
/// <remarks>Represents Name required attribute of URI element. For more details see paragraph 6.5.30 in Xfdf specification.
70+
/// <summary>Represents Name, required attribute of URI element.</summary>
71+
/// <remarks>Represents Name, required attribute of URI element. For more details see paragraph 6.5.30 in Xfdf specification.
6172
/// </remarks>
6273
private PdfString uri;
6374

64-
/// <summary>Represents IsMap optional attribute of URI element.</summary>
65-
/// <remarks>Represents IsMap optional attribute of URI element. For more details see paragraph 6.5.30 in Xfdf specification.
75+
/// <summary>Represents IsMap, optional attribute of URI element.</summary>
76+
/// <remarks>Represents IsMap, optional attribute of URI element. For more details see paragraph 6.5.30 in Xfdf specification.
6677
/// </remarks>
6778
private bool isMap;
6879

69-
/// <summary>Represents Name required attribute of Named element.</summary>
70-
/// <remarks>Represents Name required attribute of Named element. For more details see paragraph 6.5.24 in Xfdf specification.
80+
/// <summary>Represents Name, required attribute of Named element.</summary>
81+
/// <remarks>Represents Name, required attribute of Named element. For more details see paragraph 6.5.24 in Xfdf specification.
7182
/// </remarks>
7283
private PdfName nameAction;
7384

@@ -79,14 +90,14 @@ public class ActionObject {
7990
/// </remarks>
8091
private String fileOriginalName;
8192

82-
/// <summary>Represents NewWindows optional attribute of Launch element.</summary>
83-
/// <remarks>Represents NewWindows optional attribute of Launch element. For more details see paragraph 6.5.23 in Xfdf specification.
93+
/// <summary>Represents NewWindow, optional attribute of Launch element.</summary>
94+
/// <remarks>Represents NewWindow, optional attribute of Launch element. For more details see paragraph 6.5.23 in Xfdf specification.
8495
/// </remarks>
8596
private bool isNewWindow;
8697

87-
/// <summary>Represents Dest inner element of link, GoTo, and GoToR elements.</summary>
98+
/// <summary>Represents Dest, inner element of link, GoTo, and GoToR elements.</summary>
8899
/// <remarks>
89-
/// Represents Dest inner element of link, GoTo, and GoToR elements.
100+
/// Represents Dest, inner element of link, GoTo, and GoToR elements.
90101
/// Corresponds to Dest key in link annotation dictionary.
91102
/// For more details see paragraph 6.5.10 in Xfdf specification.
92103
/// </remarks>
@@ -96,64 +107,144 @@ public ActionObject(PdfName type) {
96107
this.type = type;
97108
}
98109

110+
/// <summary>Returns the type of inner action element.</summary>
111+
/// <remarks>
112+
/// Returns the type of inner action element. Possible values:
113+
/// <see cref="iText.Kernel.Pdf.PdfName.URI"/>
114+
/// ,
115+
/// <see cref="iText.Kernel.Pdf.PdfName.Launch"/>
116+
/// ,
117+
/// <see cref="iText.Kernel.Pdf.PdfName.GoTo"/>
118+
/// ,
119+
/// <see cref="iText.Kernel.Pdf.PdfName.GoToR"/>
120+
/// ,
121+
/// <see cref="iText.Kernel.Pdf.PdfName.Named"/>.
122+
/// </remarks>
99123
public virtual PdfName GetType() {
100124
return type;
101125
}
102126

127+
/// <summary>Sets the type of inner action element.</summary>
128+
/// <remarks>
129+
/// Sets the type of inner action element. Possible values:
130+
/// <see cref="iText.Kernel.Pdf.PdfName.URI"/>
131+
/// ,
132+
/// <see cref="iText.Kernel.Pdf.PdfName.Launch"/>
133+
/// ,
134+
/// <see cref="iText.Kernel.Pdf.PdfName.GoTo"/>
135+
/// ,
136+
/// <see cref="iText.Kernel.Pdf.PdfName.GoToR"/>
137+
/// ,
138+
/// <see cref="iText.Kernel.Pdf.PdfName.Named"/>.
139+
/// </remarks>
103140
public virtual iText.Forms.Xfdf.ActionObject SetType(PdfName type) {
104141
this.type = type;
105142
return this;
106143
}
107144

145+
/// <summary>Gets the string value of URI elements.</summary>
146+
/// <remarks>
147+
/// Gets the string value of URI elements. Corresponds to Name, required attribute of URI element.
148+
/// For more details see paragraph 6.5.30 in Xfdf specification.
149+
/// </remarks>
108150
public virtual PdfString GetUri() {
109151
return uri;
110152
}
111153

154+
/// <summary>Sets the string value of URI elements.</summary>
155+
/// <remarks>
156+
/// Sets the string value of URI elements. Corresponds to Name, required attribute of URI element.
157+
/// For more details see paragraph 6.5.30 in Xfdf specification.
158+
/// </remarks>
112159
public virtual iText.Forms.Xfdf.ActionObject SetUri(PdfString uri) {
113160
this.uri = uri;
114161
return this;
115162
}
116163

164+
/// <summary>Gets IsMap, optional attribute of URI element.</summary>
165+
/// <remarks>Gets IsMap, optional attribute of URI element. For more details see paragraph 6.5.30 in Xfdf specification.
166+
/// </remarks>
117167
public virtual bool IsMap() {
118168
return isMap;
119169
}
120170

171+
/// <summary>Sets IsMap, optional attribute of URI element.</summary>
172+
/// <remarks>Sets IsMap, optional attribute of URI element. For more details see paragraph 6.5.30 in Xfdf specification.
173+
/// </remarks>
121174
public virtual iText.Forms.Xfdf.ActionObject SetMap(bool map) {
122175
isMap = map;
123176
return this;
124177
}
125178

179+
/// <summary>Gets the value of Name, required attribute of Named element.</summary>
180+
/// <remarks>Gets the value of Name, required attribute of Named element. For more details see paragraph 6.5.24 in Xfdf specification.
181+
/// </remarks>
126182
public virtual PdfName GetNameAction() {
127183
return nameAction;
128184
}
129185

186+
/// <summary>Sets the value of Name, required attribute of Named element.</summary>
187+
/// <remarks>Sets the value of Name, required attribute of Named element. For more details see paragraph 6.5.24 in Xfdf specification.
188+
/// </remarks>
130189
public virtual iText.Forms.Xfdf.ActionObject SetNameAction(PdfName nameAction) {
131190
this.nameAction = nameAction;
132191
return this;
133192
}
134193

194+
/// <summary>Gets the string value of OriginalName, required attribute of File inner element of GoToR or Launch element.
195+
/// </summary>
196+
/// <remarks>
197+
/// Gets the string value of OriginalName, required attribute of File inner element of GoToR or Launch element.
198+
/// Corresponds to F key in go-to action or launch dictionaries.
199+
/// For more details see paragraphs 6.5.11, 6.5.23 in Xfdf specification.
200+
/// </remarks>
135201
public virtual String GetFileOriginalName() {
136202
return fileOriginalName;
137203
}
138204

205+
/// <summary>Sets the string value of OriginalName, required attribute of File inner element of GoToR or Launch element.
206+
/// </summary>
207+
/// <remarks>
208+
/// Sets the string value of OriginalName, required attribute of File inner element of GoToR or Launch element.
209+
/// Corresponds to F key in go-to action or launch dictionaries.
210+
/// For more details see paragraphs 6.5.11, 6.5.23 in Xfdf specification.
211+
/// </remarks>
139212
public virtual iText.Forms.Xfdf.ActionObject SetFileOriginalName(String fileOriginalName) {
140213
this.fileOriginalName = fileOriginalName;
141214
return this;
142215
}
143216

217+
/// <summary>Sets the boolean value of NewWindow, optional attribute of Launch element.</summary>
218+
/// <remarks>Sets the boolean value of NewWindow, optional attribute of Launch element. For more details see paragraph 6.5.23 in Xfdf specification.
219+
/// </remarks>
144220
public virtual bool IsNewWindow() {
145221
return isNewWindow;
146222
}
147223

224+
/// <summary>Gets the boolean value of NewWindow, optional attribute of Launch element.</summary>
225+
/// <remarks>Gets the boolean value of NewWindow, optional attribute of Launch element. For more details see paragraph 6.5.23 in Xfdf specification.
226+
/// </remarks>
148227
public virtual iText.Forms.Xfdf.ActionObject SetNewWindow(bool newWindow) {
149228
isNewWindow = newWindow;
150229
return this;
151230
}
152231

232+
/// <summary>Gets Dest, inner element of link, GoTo, and GoToR elements.</summary>
233+
/// <remarks>
234+
/// Gets Dest, inner element of link, GoTo, and GoToR elements.
235+
/// Corresponds to Dest key in link annotation dictionary.
236+
/// For more details see paragraph 6.5.10 in Xfdf specification.
237+
/// </remarks>
153238
public virtual DestObject GetDestination() {
154239
return destination;
155240
}
156241

242+
/// <summary>Sets Dest, inner element of link, GoTo, and GoToR elements.</summary>
243+
/// <remarks>
244+
/// Sets Dest, inner element of link, GoTo, and GoToR elements.
245+
/// Corresponds to Dest key in link annotation dictionary.
246+
/// For more details see paragraph 6.5.10 in Xfdf specification.
247+
/// </remarks>
157248
public virtual iText.Forms.Xfdf.ActionObject SetDestination(DestObject destination) {
158249
this.destination = destination;
159250
return this;

0 commit comments

Comments
 (0)