Return-Path: X-Original-To: apmail-pdfbox-commits-archive@www.apache.org Delivered-To: apmail-pdfbox-commits-archive@www.apache.org Received: from mail.apache.org (hermes.apache.org [140.211.11.3]) by minotaur.apache.org (Postfix) with SMTP id 945F217444 for ; Mon, 30 Mar 2015 05:58:35 +0000 (UTC) Received: (qmail 28564 invoked by uid 500); 30 Mar 2015 05:51:49 -0000 Delivered-To: apmail-pdfbox-commits-archive@pdfbox.apache.org Received: (qmail 28508 invoked by uid 500); 30 Mar 2015 05:51:49 -0000 Mailing-List: contact commits-help@pdfbox.apache.org; run by ezmlm Precedence: bulk List-Help: List-Unsubscribe: List-Post: List-Id: Reply-To: dev@pdfbox.apache.org Delivered-To: mailing list commits@pdfbox.apache.org Received: (qmail 27983 invoked by uid 99); 30 Mar 2015 05:51:48 -0000 Received: from eris.apache.org (HELO hades.apache.org) (140.211.11.105) by apache.org (qpsmtpd/0.29) with ESMTP; Mon, 30 Mar 2015 05:51:48 +0000 Received: from hades.apache.org (localhost [127.0.0.1]) by hades.apache.org (ASF Mail Server at hades.apache.org) with ESMTP id 9C416AC043C for ; Mon, 30 Mar 2015 05:51:48 +0000 (UTC) Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit Subject: svn commit: r1669997 [44/49] - in /pdfbox/cmssite/trunk/content/docs/2.0.0-SNAPSHOT/javadocs: ./ org/apache/pdfbox/contentstream/ org/apache/pdfbox/contentstream/class-use/ org/apache/pdfbox/contentstream/operator/ org/apache/pdfbox/contentstream/opera... Date: Mon, 30 Mar 2015 05:51:24 -0000 To: commits@pdfbox.apache.org From: msahyoun@apache.org X-Mailer: svnmailer-1.0.9 Message-Id: <20150330055148.9C416AC043C@hades.apache.org> Modified: pdfbox/cmssite/trunk/content/docs/2.0.0-SNAPSHOT/javadocs/org/apache/pdfbox/pdmodel/interactive/form/PDPushButton.html URL: http://svn.apache.org/viewvc/pdfbox/cmssite/trunk/content/docs/2.0.0-SNAPSHOT/javadocs/org/apache/pdfbox/pdmodel/interactive/form/PDPushButton.html?rev=1669997&r1=1669996&r2=1669997&view=diff ============================================================================== --- pdfbox/cmssite/trunk/content/docs/2.0.0-SNAPSHOT/javadocs/org/apache/pdfbox/pdmodel/interactive/form/PDPushButton.html (original) +++ pdfbox/cmssite/trunk/content/docs/2.0.0-SNAPSHOT/javadocs/org/apache/pdfbox/pdmodel/interactive/form/PDPushButton.html Mon Mar 30 05:51:10 2015 @@ -2,10 +2,10 @@ - + PDPushButton (Apache PDFBox 2.0.0-SNAPSHOT API) - + @@ -139,7 +139,7 @@ extends PDButton -FLAG_NO_TOGGLE_TO_OFF, FLAG_PUSHBUTTON, FLAG_RADIO, FLAG_RADIOS_IN_UNISON +FLAG_PUSHBUTTON, FLAG_RADIO, FLAG_RADIOS_IN_UNISON @@ -155,6 +155,9 @@ extends Constructor and Description +PDPushButton(PDAcroForm theAcroForm)  + + PDPushButton(PDAcroForm theAcroForm, COSDictionary field, PDFieldTreeNode parentNode) @@ -177,27 +180,39 @@ extends Method and Description -Object +String getDefaultValue() -
Get the value of the "DV" entry.
+
Get the fields default value.
-Object -getValue() -
Get the value of the "V" entry.
+List<String> +getOptions() +
Get the fields options.
+String +getValue() +
Get the fields value.
+ + + void setDefaultValue(String defaultValue) -
Set the value of the "DV" entry.
+
Set the fields default value.
+ + + +void +setOptions(List<String> values) +
Set the fields options.
void setValue(String fieldValue) -
Set the value of the "V" entry.
+
Set the fields value.
@@ -206,7 +221,7 @@ extends PDButton -getOptions, setOptions +isPushButton, isRadioButton, setPushButton, setRadioButton
  • @@ -243,6 +258,16 @@ extends + + + @@ -270,22 +295,14 @@ extends

  • getDefaultValue

    -
    public Object getDefaultValue()
    -
    Description copied from class: PDFieldTreeNode
    -
    Get the value of the "DV" entry. The "DV" entry is an inheritable attribute. - - This will return null if the "DV" entry doesn't exist or if it has no value assigned. +
    public String getDefaultValue()
    +
    Get the fields default value. - The different field types do require specific object types for their value - e.g. for RadioButtons the DV entry needs to be a name object. - If the value doesn't match the expected type an IOException is thrown. Such a wrong entry might - have been set with a different library or by using PDFBox low level COS model. - - To get the value in such cases the lower level COS model can be used.
    + A push button field does not have a field value.
    -
    Specified by:
    -
    getDefaultValue in class PDFieldTreeNode
    -
    Returns:
    The value of this field.
    +
    Overrides:
    +
    getDefaultValue in class PDButton
    +
    Returns:
    This will always return an empty string.
@@ -295,23 +312,49 @@ extends

setDefaultValue

public void setDefaultValue(String defaultValue)
-
Description copied from class: PDFieldTreeNode
-
Set the value of the "DV" entry. The "DV" entry is an inheritable attribute. +
Set the fields default value. - The different field types do require specific object types for their value - e.g. for RadioButtons the DV entry needs to be a name object. This needs to be handled by the - individual classes. + A push button field does not have a field value.
+
+
Overrides:
+
setDefaultValue in class PDButton
+
Parameters:
defaultValue - The field doesn't support setting any value
+
Throws:
+
IllegalArgumentException - when trying to set a value other than null
+ + + + + +
    +
  • +

    getOptions

    +
    public List<String> getOptions()
    +
    Get the fields options. - Trying to set the default value for a PDPushButton field will lead to an - IllegalArgumentException as PDPushButton fields do not support setting the - entry although, common to all field types, the DV entry shall not be set. + A push button field does not have option value.
    +
    +
    Overrides:
    +
    getOptions in class PDButton
    +
    Returns:
    This will always return an empty List.
    +
    • +
+ + + +
    +
  • +

    setOptions

    +
    public void setOptions(List<String> values)
    +
    Set the fields options. - As a result it might be necessary to check the type of the value before - reusing it.
    + A push button field does not have a option values.
-
Specified by:
-
setDefaultValue in class PDFieldTreeNode
-
Parameters:
defaultValue - The new default field value.
+
Overrides:
+
setOptions in class PDButton
+
Parameters:
values - The field doesn't support setting any option value
+
Throws:
+
IllegalArgumentException - when trying to set the a value other than null or an empty list.
See Also:
PDButton.getOptions()
@@ -320,25 +363,14 @@ extends

  • getValue

    -
    public Object getValue()
    -
    Description copied from class: PDFieldTreeNode
    -
    Get the value of the "V" entry. The "V" entry is an inheritable attribute. +
    public String getValue()
    +
    Get the fields value. - This will return null if the "V" entry doesn't exist or if it has no value assigned. - - The different field types do require specific object types for their value - e.g. for RadioButtons the V entry needs to be a name object. - If the value doesn't match the expected type an IOException is thrown. Such a wrong entry might - have been set with a different library or by using PDFBox low level COS model. - - To get the value in such cases the lower level COS model can be used. - - As a result it might be necessary to check the type of the value before - reusing it.
    + A push button field does not have field value.
    Specified by:
    getValue in class PDFieldTreeNode
    -
    Returns:
    The value of this entry.
    +
    Returns:
    This will always return an empty String.
    • @@ -348,23 +380,15 @@ extends

    setValue

    public void setValue(String fieldValue)
    -
    Description copied from class: PDFieldTreeNode
    -
    Set the value of the "V" entry. The "V" entry is an inheritable attribute. - - The different field types do require specific object types for their value - e.g. for RadioButtons the V entry needs to be a name object. This needs to be handled by the - individual classes. - - Trying to set the value for a PDPushButton field will lead to an - IllegalArgumentException as PDPushButton fields do not support setting the - entry although, common to all field types, the DV entry shall not be set. +
    Set the fields value. - As a result it might be necessary to check the type of the value before - reusing it.
    + A push button field does not have a field value.
    Specified by:
    setValue in class PDFieldTreeNode
    -
    Parameters:
    fieldValue - The new field value.
    +
    Parameters:
    fieldValue - The field doesn't support setting any field value.
    +
    Throws:
    +
    IllegalArgumentException - when trying to set the a value other than null or an empty String.
    Modified: pdfbox/cmssite/trunk/content/docs/2.0.0-SNAPSHOT/javadocs/org/apache/pdfbox/pdmodel/interactive/form/PDRadioButton.html URL: http://svn.apache.org/viewvc/pdfbox/cmssite/trunk/content/docs/2.0.0-SNAPSHOT/javadocs/org/apache/pdfbox/pdmodel/interactive/form/PDRadioButton.html?rev=1669997&r1=1669996&r2=1669997&view=diff ============================================================================== --- pdfbox/cmssite/trunk/content/docs/2.0.0-SNAPSHOT/javadocs/org/apache/pdfbox/pdmodel/interactive/form/PDRadioButton.html (original) +++ pdfbox/cmssite/trunk/content/docs/2.0.0-SNAPSHOT/javadocs/org/apache/pdfbox/pdmodel/interactive/form/PDRadioButton.html Mon Mar 30 05:51:10 2015 @@ -2,10 +2,10 @@ - + PDRadioButton (Apache PDFBox 2.0.0-SNAPSHOT API) - + @@ -63,13 +63,13 @@ @@ -133,12 +133,25 @@ extends +Fields  + +Modifier and Type +Field and Description + + +static int +FLAG_NO_TOGGLE_TO_OFF +
    A Ff flag.
    + + + @@ -154,6 +167,9 @@ extends Constructor and Description +PDRadioButton(PDAcroForm theAcroForm)  + + PDRadioButton(PDAcroForm theAcroForm, COSDictionary field, PDFieldTreeNode parentNode) @@ -176,9 +192,9 @@ extends Method and Description -COSName -getDefaultValue() -
    Get the value of the "DV" entry.
    +String +getExportValue() +
    This will get the export value.
    @@ -193,19 +209,13 @@ extends void -setDefaultValue(String defaultValue) -
    Set the fields default value.
    - - - -void setRadiosInUnison(boolean radiosInUnison)
    From the PDF Spec
    If set, a group of radio buttons within a radio button field that use the same value for the on state will turn on and off in unison; that is if one is checked, they are all checked.
    - + void setValue(String fieldValue)
    Set the field value.
    @@ -217,7 +227,7 @@ extends PDButton -getOptions, setOptions +getDefaultValue, getOptions, isPushButton, isRadioButton, setDefaultValue, setOptions, setPushButton, setRadioBut ton
    • @@ -248,12 +258,41 @@ extends
      • + + - +
        • -

          getDefaultValue

          -
          public COSName getDefaultValue()
-                        throws IOException
          -
          Description copied from class: PDFieldTreeNode
          -
          Get the value of the "DV" entry. The "DV" entry is an inheritable attribute. - - This will return null if the "DV" entry doesn't exist or if it has no value assigned. - - The different field types do require specific object types for their value - e.g. for RadioButtons the DV entry needs to be a name object. - If the value doesn't match the expected type an IOException is thrown. Such a wrong entry might - have been set with a different library or by using PDFBox low level COS model. - - To get the value in such cases the lower level COS model can be used.
          -
          -
          Specified by:
          -
          getDefaultValue in class PDFieldTreeNode
          -
          Returns:
          The value of this field.
          +

          getExportValue

          +
          public String getExportValue()
+                      throws IOException
          +
          This will get the export value. +

          + A RadioButton might have an export value to allow field values + which can not be encoded as PDFDocEncoding or for the same export value + being assigned to multiple RadioButtons in a group.
          + To define an export value the RadioButton must define options PDButton.setOptions(List) + which correspond to the individual items within the RadioButton.

          +

          + The method will either return the value from the options entry or in case there + is no such entry the fields value

          +
          Returns:
          the export value of the field.
          Throws:
          -
          IOException - If there is an error reading the data for this field - or the type is not in line with the fields required type.
          -
          • -
        - - - -
          -
        • -

          setDefaultValue

          -
          public void setDefaultValue(String defaultValue)
          -
          Set the fields default value. - - The field value holds a name object which is corresponding to the - appearance state representing the corresponding appearance - from the appearance directory. - - The default value is used to represent the initial state of the - checkbox or to revert when resetting the form.
          -
          -
          Specified by:
          -
          setDefaultValue in class PDFieldTreeNode
          -
          Parameters:
          defaultValue - the string to set the field value.
          +
          IOException - in case the fields value can not be retrieved
        @@ -450,13 +463,13 @@ extends
      • Summary: 
      • Nested | 
        • -
      • Field | 
        • +
      • Field | 
      • Constr | 
      • Method
      Modified: pdfbox/cmssite/trunk/content/docs/2.0.0-SNAPSHOT/javadocs/org/apache/pdfbox/pdmodel/interactive/form/PDSignatureField.html URL: http://svn.apache.org/viewvc/pdfbox/cmssite/trunk/content/docs/2.0.0-SNAPSHOT/javadocs/org/apache/pdfbox/pdmodel/interactive/form/PDSignatureField.html?rev=1669997&r1=1669996&r2=1669997&view=diff ============================================================================== --- pdfbox/cmssite/trunk/content/docs/2.0.0-SNAPSHOT/javadocs/org/apache/pdfbox/pdmodel/interactive/form/PDSignatureField.html (original) +++ pdfbox/cmssite/trunk/content/docs/2.0.0-SNAPSHOT/javadocs/org/apache/pdfbox/pdmodel/interactive/form/PDSignatureField.html Mon Mar 30 05:51:10 2015 @@ -2,10 +2,10 @@ - + PDSignatureField (Apache PDFBox 2.0.0-SNAPSHOT API) - + Modified: pdfbox/cmssite/trunk/content/docs/2.0.0-SNAPSHOT/javadocs/org/apache/pdfbox/pdmodel/interactive/form/PDTextField.html URL: http://svn.apache.org/viewvc/pdfbox/cmssite/trunk/content/docs/2.0.0-SNAPSHOT/javadocs/org/apache/pdfbox/pdmodel/interactive/form/PDTextField.html?rev=1669997&r1=1669996&r2=1669997&view=diff ============================================================================== --- pdfbox/cmssite/trunk/content/docs/2.0.0-SNAPSHOT/javadocs/org/apache/pdfbox/pdmodel/interactive/form/PDTextField.html (original) +++ pdfbox/cmssite/trunk/content/docs/2.0.0-SNAPSHOT/javadocs/org/apache/pdfbox/pdmodel/interactive/form/PDTextField.html Mon Mar 30 05:51:10 2015 @@ -2,10 +2,10 @@ - + PDTextField (Apache PDFBox 2.0.0-SNAPSHOT API) - + @@ -206,79 +206,91 @@ extends +PDTextStream +getValueAsStream() +
      Get the fields value.
      + + + boolean isComb()  - + boolean isFileSelect()  - + boolean isMultiline()  - + boolean isPassword()  - + boolean isRichText()  - + void setComb(boolean comb)
      Set the comb bit.
      - + void setDefaultValue(String value)
      Sets the default value for the field.
      - + void setDoNotScroll(boolean doNotScroll)
      Set the doNotScroll bit.
      - + void setDoNotSpellCheck(boolean doNotSpellCheck)
      Set the doNotSpellCheck bit.
      - + void setFileSelect(boolean fileSelect)
      Set the file select bit.
      - + void setMaxLen(int maxLen)
      Sets the maximum number of characters of the text field.
      - + void setMultiline(boolean multiline)
      Set the multiline bit.
      - + void setPassword(boolean password)
      Set the password bit.
      - + void setRichText(boolean richText)
      Set the richText bit.
      + +void +setValue(PDTextStream textStream) +
      Set the fields value.
      + + void setValue(String value) @@ -291,7 +303,7 @@ extends PDVariableText -getDefaultAppearance, getDefaultStyleString, getQ, getRichTextValue, setDefaultAppearance, setDefaultStyleString, setQ, setRichTextValue
      • +getDefaultAppearance, getDefaultStyleString, getQ, getRichTextValue, getRichTextValueAsStream, setDefaultAppearance, setDefaultStyleString, setQ, setRichTextValue, setRichTextValue
    + + + +
      +
    • +

      setValue

      +
      public void setValue(PDTextStream textStream)
+              throws IOException
      +
      Set the fields value. + + The value is stored in the field dictionaries "V" entry.
      +
      Parameters:
      textStream - the value
      +
      Throws:
      +
      IOException - if there is an error setting the field value
    -
      +

      • getValue

        public String getValue()
@@ -594,6 +629,22 @@ extends Throws:
 
        IOException - if the field dictionary entry is not a text type
        • +
      + + + +
        +
      • +

        getValueAsStream

        +
        public PDTextStream getValueAsStream()
+                              throws IOException
        +
        Get the fields value. + + The value is stored in the field dictionaries "V" entry.
        +
        Returns:
        The value of this entry.
        +
        Throws:
        +
        IOException - if the field dictionary entry is not a text type
        +
    Modified: pdfbox/cmssite/trunk/content/docs/2.0.0-SNAPSHOT/javadocs/org/apache/pdfbox/pdmodel/interactive/form/PDVariableText.html URL: http://svn.apache.org/viewvc/pdfbox/cmssite/trunk/content/docs/2.0.0-SNAPSHOT/javadocs/org/apache/pdfbox/pdmodel/interactive/form/PDVariableText.html?rev=1669997&r1=1669996&r2=1669997&view=diff ============================================================================== --- pdfbox/cmssite/trunk/content/docs/2.0.0-SNAPSHOT/javadocs/org/apache/pdfbox/pdmodel/interactive/form/PDVariableText.html (original) +++ pdfbox/cmssite/trunk/content/docs/2.0.0-SNAPSHOT/javadocs/org/apache/pdfbox/pdmodel/interactive/form/PDVariableText.html Mon Mar 30 05:51:10 2015 @@ -2,10 +2,10 @@ - + PDVariableText (Apache PDFBox 2.0.0-SNAPSHOT API) - + @@ -196,7 +196,7 @@ extends Method and Description -COSString +String getDefaultAppearance()
    Get the default appearance.
    @@ -220,23 +220,35 @@ extends +PDTextStream +getRichTextValueAsStream() +
    Get the fields rich text value.
    + + + void setDefaultAppearance(String daValue)
    Set the default appearance.
    - + void setDefaultStyleString(String defaultStyleString)
    Set the default style string.
    - + void setQ(int q)
    This will set the quadding/justification of the text.
    + +void +setRichTextValue(PDTextStream richTextValue) +
    Set the fields rich text value.
    + + void setRichTextValue(String richTextValue) @@ -347,7 +359,7 @@ extends

  • getDefaultAppearance

    -
    public COSString getDefaultAppearance()
    +
    public String getDefaultAppearance()
    Get the default appearance. This is an inheritable attribute. @@ -435,20 +447,64 @@ extends

  • getRichTextValue

    -
    public String getRichTextValue()
    +
    public String getRichTextValue()
+                        throws IOException
    Get the fields rich text value.
    -
    Returns:
    the rich text value string
    +
    Returns:
    the rich text value string
    +
    Throws:
    +
    IOException - if the field dictionary entry is not a text type
    +
    • + + + + +
      +
    • +

      getRichTextValueAsStream

      +
      public PDTextStream getRichTextValueAsStream()
+                                      throws IOException
      +
      Get the fields rich text value. + + The value is stored in the field dictionaries "V" entry.
      +
      Returns:
      The value of this entry.
      +
      Throws:
      +
      IOException - if the field dictionary entry is not a text type
    -
      +

      • setRichTextValue

        public void setRichTextValue(String richTextValue)
        Set the fields rich text value. +

        + Setting the rich text value will not generate the appearance + for the field. +
        + You can set PDAcroForm.setNeedAppearances(Boolean) to + signal a conforming reader to generate the appearance stream. +

        +

        + For long text it's more efficient to provide the text content as a + text stream setRichTextValue(PDTextStream) +

        + + Providing null as the value will remove the default style string.
        +
        Parameters:
        richTextValue - a rich text string
        +
        • +
      + + + + Modified: pdfbox/cmssite/trunk/content/docs/2.0.0-SNAPSHOT/javadocs/org/apache/pdfbox/pdmodel/interactive/form/class-use/PDButton.html URL: http://svn.apache.org/viewvc/pdfbox/cmssite/trunk/content/docs/2.0.0-SNAPSHOT/javadocs/org/apache/pdfbox/pdmodel/interactive/form/class-use/PDButton.html?rev=1669997&r1=1669996&r2=1669997&view=diff ============================================================================== --- pdfbox/cmssite/trunk/content/docs/2.0.0-SNAPSHOT/javadocs/org/apache/pdfbox/pdmodel/interactive/form/class-use/PDButton.html (original) +++ pdfbox/cmssite/trunk/content/docs/2.0.0-SNAPSHOT/javadocs/org/apache/pdfbox/pdmodel/interactive/form/class-use/PDButton.html Mon Mar 30 05:51:10 2015 @@ -2,10 +2,10 @@ - + Uses of Class org.apache.pdfbox.pdmodel.interactive.form.PDButton (Apache PDFBox 2.0.0-SNAPSHOT API) - + Modified: pdfbox/cmssite/trunk/content/docs/2.0.0-SNAPSHOT/javadocs/org/apache/pdfbox/pdmodel/interactive/form/class-use/PDCheckbox.html URL: http://svn.apache.org/viewvc/pdfbox/cmssite/trunk/content/docs/2.0.0-SNAPSHOT/javadocs/org/apache/pdfbox/pdmodel/interactive/form/class-use/PDCheckbox.html?rev=1669997&r1=1669996&r2=1669997&view=diff ============================================================================== --- pdfbox/cmssite/trunk/content/docs/2.0.0-SNAPSHOT/javadocs/org/apache/pdfbox/pdmodel/interactive/form/class-use/PDCheckbox.html (original) +++ pdfbox/cmssite/trunk/content/docs/2.0.0-SNAPSHOT/javadocs/org/apache/pdfbox/pdmodel/interactive/form/class-use/PDCheckbox.html Mon Mar 30 05:51:10 2015 @@ -2,10 +2,10 @@ - + Uses of Class org.apache.pdfbox.pdmodel.interactive.form.PDCheckbox (Apache PDFBox 2.0.0-SNAPSHOT API) - +