PDButton.java
/*
* Licensed to the Apache Software Foundation (ASF) under one or more
* contributor license agreements. See the NOTICE file distributed with
* this work for additional information regarding copyright ownership.
* The ASF licenses this file to You under the Apache License, Version 2.0
* (the "License"); you may not use this file except in compliance with
* the License. You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package org.apache.pdfbox.pdmodel.interactive.form;
import org.apache.pdfbox.cos.COSArray;
import org.apache.pdfbox.cos.COSBase;
import org.apache.pdfbox.cos.COSDictionary;
import org.apache.pdfbox.cos.COSName;
import org.apache.pdfbox.cos.COSString;
import java.io.IOException;
import java.util.Collections;
import java.util.LinkedHashSet;
import java.util.List;
import java.util.Set;
import org.apache.pdfbox.pdmodel.interactive.annotation.PDAnnotationWidget;
import org.apache.pdfbox.pdmodel.interactive.annotation.PDAppearanceDictionary;
import org.apache.pdfbox.pdmodel.interactive.annotation.PDAppearanceEntry;
/**
* A button field represents an interactive control on the screen
* that the user can manipulate with the mouse.
*
* @author sug
*/
public abstract class PDButton extends PDTerminalField
{
/**
* A Ff flag. If set, the field is a set of radio buttons
*/
static final int FLAG_RADIO = 1 << 15;
/**
* A Ff flag. If set, the field is a pushbutton.
*/
static final int FLAG_PUSHBUTTON = 1 << 16;
/**
* A Ff flag. If set, radio buttons individual fields, using the same
* value for the on state will turn on and off in unison.
*/
static final int FLAG_RADIOS_IN_UNISON = 1 << 25;
/**
* @see PDField#PDField(PDAcroForm)
*
* @param acroForm The acroform.
*/
PDButton(PDAcroForm acroForm)
{
super(acroForm);
getCOSObject().setItem(COSName.FT, COSName.BTN);
}
/**
* Constructor.
*
* @param acroForm The form that this field is part of.
* @param field the PDF object to represent as a field.
* @param parent the parent node of the node
*/
PDButton(PDAcroForm acroForm, COSDictionary field, PDNonTerminalField parent)
{
super(acroForm, field, parent);
}
/**
* Determines if push button bit is set.
*
* @return true if type of button field is a push button.
*/
public boolean isPushButton()
{
return getCOSObject().getFlag(COSName.FF, FLAG_PUSHBUTTON);
}
/**
* Determines if radio button bit is set.
*
* @return true if type of button field is a radio button.
*/
public boolean isRadioButton()
{
return getCOSObject().getFlag(COSName.FF, FLAG_RADIO);
}
/**
* Returns the selected value.
*
* <p>Off is the default value which will also be returned if the
* value hasn't been set at all.
*
* @return A non-null string.
*/
public String getValue()
{
COSBase value = getInheritableAttribute(COSName.V);
if (value instanceof COSName)
{
String stringValue = ((COSName)value).getName();
List<String> exportValues = getExportValues();
if (!exportValues.isEmpty())
{
try
{
int idx = Integer.parseInt(stringValue, 10);
if (idx >= 0 && idx < exportValues.size())
{
return exportValues.get(idx);
}
}
catch (NumberFormatException nfe)
{
return stringValue;
}
}
return stringValue;
}
else
{
// Off is the default value if there is nothing else set.
// See PDF Spec.
return "Off";
}
}
/**
* Set the selected option given its name, and try to update the visual appearance.
*
* @param value Name of option to select
* @throws IOException if the value could not be set
* @throws IllegalArgumentException if the value is not a valid option.
*/
@Override
public void setValue(String value) throws IOException
{
checkValue(value);
// if there are export values/an Opt entry there is a different
// approach to setting the value
if (!getExportValues().isEmpty())
{
updateByOption(value);
}
else
{
updateByValue(value);
}
applyChange();
}
/**
* Set the selected option given its index, and try to update the visual appearance.
*
* NOTE: this method is only usable if there are export values and used for
* radio buttons with FLAG_RADIOS_IN_UNISON not set.
*
* @param index index of option to be selected
* @throws IOException if the value could not be set
* @throws IllegalArgumentException if the index provided is not a valid index.
*/
public void setValue(int index) throws IOException
{
if (getExportValues().isEmpty() || index < 0 || index >= getExportValues().size())
{
throw new IllegalArgumentException("index '" + index
+ "' is not a valid index for the field " + getFullyQualifiedName()
+ ", valid indices are from 0 to " + (getExportValues().size() - 1));
}
updateByValue(String.valueOf(index));
applyChange();
}
/**
* Returns the default value, if any.
*
* @return A non-null string.
*/
public String getDefaultValue()
{
COSBase value = getInheritableAttribute(COSName.DV);
if (value instanceof COSName)
{
return ((COSName)value).getName();
}
else
{
return "";
}
}
/**
* Sets the default value.
*
* @param value Name of option to select
* @throws IllegalArgumentException if the value is not a valid option.
*/
public void setDefaultValue(String value)
{
checkValue(value);
getCOSObject().setName(COSName.DV, value);
}
@Override
public String getValueAsString()
{
return getValue();
}
/**
* This will get the (optional) export values.
*
* <p>The export values are defined in the field dictionaries /Opt key.</p>
*
* <p>The option values are used to define the export values
* for the field to
* <ul>
* <li>hold values in non-Latin writing systems as name objects, which represent the field value, are limited
* to PDFDocEncoding
* </li>
* <li>allow radio buttons having the same export value to be handled independently
* </li>
* </ul>
*
* @return List containing all possible export values. If there is no /Opt entry an empty list will be returned.
*
* @see #getOnValues()
*/
public List<String> getExportValues()
{
COSBase value = getInheritableAttribute(COSName.OPT);
if (value instanceof COSString)
{
return Collections.singletonList(((COSString) value).getString());
}
else if (value instanceof COSArray)
{
return ((COSArray) value).toCOSStringStringList();
}
return Collections.emptyList();
}
/**
* This will set the export values.
*
* @see #getExportValues()
* @param values List containing all possible export values. Supplying null or an empty list will remove the Opt entry.
*/
public void setExportValues(List<String> values)
{
COSArray cosValues;
if (values != null && !values.isEmpty())
{
cosValues = COSArray.ofCOSStrings(values);
getCOSObject().setItem(COSName.OPT, cosValues);
}
else
{
getCOSObject().removeItem(COSName.OPT);
}
}
@Override
void constructAppearances() throws IOException
{
List<String> exportValues = getExportValues();
if (!exportValues.isEmpty())
{
// the value is the index value of the option. So we need to get that
// and use it to set the value
try
{
int optionsIndex = Integer.parseInt(getValue());
if (optionsIndex < exportValues.size())
{
updateByOption(exportValues.get(optionsIndex));
}
} catch (NumberFormatException e)
{
// silently ignore that
// and don't update the appearance
}
}
else
{
updateByValue(getValue());
}
}
/**
* Get the values to set individual buttons within a group to the on state.
*
* <p>The On value could be an arbitrary string as long as it is within the limitations of
* a PDF name object. The Off value shall always be 'Off'. If not set or not part of the normal
* appearance keys 'Off' is the default</p>
*
* @return the potential values setting the check box to the On state.
* If an empty Set is returned there is no appearance definition.
*/
public Set<String> getOnValues()
{
// we need a set as the field can appear multiple times
Set<String> onValues = new LinkedHashSet<>();
List<String> exportValues = getExportValues();
if (!exportValues.isEmpty())
{
onValues.addAll(exportValues);
return onValues;
}
List<PDAnnotationWidget> widgets = this.getWidgets();
for (PDAnnotationWidget widget : widgets)
{
onValues.add(getOnValueForWidget(widget));
}
return onValues;
}
/*
* Get the on value for an individual widget by it's index.
*/
private String getOnValue(int index)
{
List<PDAnnotationWidget> widgets = this.getWidgets();
if (index < widgets.size())
{
return getOnValueForWidget(widgets.get(index));
}
return "";
}
/*
* Get the on value for an individual widget.
*/
private String getOnValueForWidget(PDAnnotationWidget widget)
{
PDAppearanceDictionary apDictionary = widget.getAppearance();
if (apDictionary != null)
{
PDAppearanceEntry normalAppearance = apDictionary.getNormalAppearance();
if (normalAppearance != null)
{
Set<COSName> entries = normalAppearance.getSubDictionary().keySet();
for (COSName entry : entries)
{
if (COSName.Off.compareTo(entry) != 0)
{
return entry.getName();
}
}
}
}
return "";
}
/**
* Checks value.
*
* @param value Name of radio button to select
* @throws IllegalArgumentException if the value is not a valid option.
*/
void checkValue(String value)
{
Set<String> onValues = getOnValues();
if (COSName.Off.getName().compareTo(value) != 0 && !onValues.contains(value))
{
throw new IllegalArgumentException("value '" + value
+ "' is not a valid option for the field " + getFullyQualifiedName()
+ ", valid values are: " + onValues + " and " + COSName.Off.getName());
}
}
private void updateByValue(String value)
{
getCOSObject().setName(COSName.V, value);
// update the appearance state (AS)
for (PDAnnotationWidget widget : getWidgets())
{
PDAppearanceDictionary appearance = widget.getAppearance();
if (appearance == null)
{
continue;
}
PDAppearanceEntry appearanceEntry = appearance.getNormalAppearance();
if (appearanceEntry.getCOSObject().containsKey(value))
{
widget.setAppearanceState(value);
}
else
{
widget.setAppearanceState(COSName.Off.getName());
}
}
}
private void updateByOption(String value)
{
List<PDAnnotationWidget> widgets = getWidgets();
List<String> options = getExportValues();
if (widgets.size() != options.size())
{
throw new IllegalArgumentException("The number of options doesn't match the number of widgets");
}
if (value.equals(COSName.Off.getName()))
{
updateByValue(value);
}
else
{
// the value is the index of the matching option
int optionsIndex = options.indexOf(value);
// get the values the options are pointing to as
// this might not be numerical
// see PDFBOX-3682
if (optionsIndex != -1)
{
updateByValue(getOnValue(optionsIndex));
}
}
}
}