/*
* Copyright 2006-2017 ICEsoft Technologies Canada Corp.
*
* Licensed 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.icepdf.ri.common.utility.annotation;
import org.icepdf.core.pobjects.Name;
import org.icepdf.core.pobjects.annotations.TextMarkupAnnotation;
import org.icepdf.ri.common.SwingController;
import org.icepdf.ri.common.views.AnnotationComponent;
import javax.swing.*;
import javax.swing.border.EtchedBorder;
import javax.swing.border.TitledBorder;
import javax.swing.event.ChangeEvent;
import javax.swing.event.ChangeListener;
import java.awt.*;
import java.awt.event.ActionEvent;
import java.awt.event.ActionListener;
import java.awt.event.ItemEvent;
import java.awt.event.ItemListener;
/**
* TextAnnotationPanel is a configuration panel for changing the properties
* of a TextAnnotationComponent and the underlying annotation component.
*
* @since 5.0
*/
@SuppressWarnings("serial")
public class TextMarkupAnnotationPanel extends AnnotationPanelAdapter implements ItemListener,
ActionListener, ChangeListener {
// default list values.
private static final int DEFAULT_TEXT_MARKUP_TYPE = 0;
private static final Color DEFAULT_BORDER_COLOR = Color.BLACK;
// text markup sub types.
private static ValueLabelItem[] TEXT_MARKUP_TYPE_LIST;
// text markup appearance properties.
private JComboBox textMarkupTypes;
private JButton colorButton;
private JSlider transparencySlider;
private TextMarkupAnnotation annotation;
public TextMarkupAnnotationPanel(SwingController controller) {
super(controller);
setLayout(new GridBagLayout());
// Setup the basics of the panel
setFocusable(true);
// Add the tabbed pane to the overall panel
createGUI();
// Start the panel disabled until an action is clicked
setEnabled(false);
revalidate();
}
/**
* Method that should be called when a new AnnotationComponent is selected by the user
* The associated object will be stored locally as currentAnnotation
* Then all of it's properties will be applied to the UI pane
* For example if the border was red, the color of the background button will
* be changed to red
*
* @param newAnnotation to set and apply to this UI
*/
public void setAnnotationComponent(AnnotationComponent newAnnotation) {
if (newAnnotation == null || newAnnotation.getAnnotation() == null) {
setEnabled(false);
return;
}
// assign the new action instance.
this.currentAnnotationComponent = newAnnotation;
// For convenience grab the Annotation object wrapped by the component
annotation = (TextMarkupAnnotation)
currentAnnotationComponent.getAnnotation();
applySelectedValue(textMarkupTypes, annotation.getSubType());
setButtonBackgroundColor(colorButton, annotation.getTextMarkupColor());
transparencySlider.setValue(Math.round(annotation.getOpacity() * 255));
// disable appearance input if we have a invisible rectangle
safeEnable(textMarkupTypes, true);
safeEnable(colorButton, true);
safeEnable(transparencySlider, true);
}
public void itemStateChanged(ItemEvent e) {
ValueLabelItem item = (ValueLabelItem) e.getItem();
if (e.getStateChange() == ItemEvent.SELECTED) {
if (e.getSource() == textMarkupTypes) {
annotation.setSubtype((Name) item.getValue());
}
// save the action state back to the document structure.
updateCurrentAnnotation();
currentAnnotationComponent.resetAppearanceShapes();
currentAnnotationComponent.repaint();
}
}
public void actionPerformed(ActionEvent e) {
if (e.getSource() == colorButton) {
Color chosenColor =
JColorChooser.showDialog(colorButton,
messageBundle.getString(
"viewer.utilityPane.annotation.textMarkup.colorChooserTitle"),
colorButton.getBackground());
if (chosenColor != null) {
// change the colour of the button background
colorButton.setBackground(chosenColor);
annotation.setTextMarkupColor(chosenColor);
// save the action state back to the document structure.
updateCurrentAnnotation();
currentAnnotationComponent.resetAppearanceShapes();
currentAnnotationComponent.repaint();
}
}
}
public void stateChanged(ChangeEvent e) {
alphaSliderChange(e, annotation);
}
/**
* Method to create link annotation GUI.
*/
private void createGUI() {
// text markup types.
if (TEXT_MARKUP_TYPE_LIST == null) {
TEXT_MARKUP_TYPE_LIST = new ValueLabelItem[]{
new ValueLabelItem(TextMarkupAnnotation.SUBTYPE_HIGHLIGHT,
"Highlight"),
new ValueLabelItem(TextMarkupAnnotation.SUBTYPE_STRIKE_OUT,
"Strikeout"),
new ValueLabelItem(TextMarkupAnnotation.SUBTYPE_UNDERLINE,
"Underline")};
}
constraints = new GridBagConstraints();
constraints.fill = GridBagConstraints.HORIZONTAL;
constraints.weightx = 1.0;
constraints.anchor = GridBagConstraints.NORTH;
constraints.anchor = GridBagConstraints.WEST;
constraints.insets = new Insets(1, 2, 1, 2);
// Create and setup an Appearance panel
setBorder(new TitledBorder(new EtchedBorder(EtchedBorder.LOWERED),
messageBundle.getString("viewer.utilityPane.annotation.textMarkup.appearance.title"),
TitledBorder.LEFT,
TitledBorder.DEFAULT_POSITION));
// Text markup type
textMarkupTypes = new JComboBox(TEXT_MARKUP_TYPE_LIST);
textMarkupTypes.setSelectedIndex(DEFAULT_TEXT_MARKUP_TYPE);
textMarkupTypes.addItemListener(this);
JLabel label = new JLabel(messageBundle.getString("viewer.utilityPane.annotation.textMarkup.highlightType"));
addGB(this, label, 0, 0, 1, 1);
addGB(this, textMarkupTypes, 1, 0, 1, 1);
// border colour
colorButton = new JButton(" ");
colorButton.addActionListener(this);
colorButton.setOpaque(true);
colorButton.setBackground(DEFAULT_BORDER_COLOR);
label = new JLabel(messageBundle.getString("viewer.utilityPane.annotation.textMarkup.colorLabel"));
addGB(this, label, 0, 2, 1, 1);
addGB(this, colorButton, 1, 2, 1, 1);
// transparency slider
transparencySlider = buildAlphaSlider();
transparencySlider.setMajorTickSpacing(255);
transparencySlider.setPaintLabels(true);
transparencySlider.addChangeListener(this);
label = new JLabel(messageBundle.getString("viewer.utilityPane.annotation.textMarkup.transparencyLabel"));
addGB(this, label, 0, 3, 1, 1);
addGB(this, transparencySlider, 1, 3, 1, 1);
}
@Override
public void setEnabled(boolean enabled) {
super.setEnabled(enabled);
safeEnable(textMarkupTypes, enabled);
safeEnable(colorButton, enabled);
safeEnable(transparencySlider, enabled);
}
/**
* Convenience method to ensure a component is safe to toggle the enabled state on
*
* @param comp to toggle
* @param enabled the status to use
* @return true on success
*/
protected boolean safeEnable(JComponent comp, boolean enabled) {
if (comp != null) {
comp.setEnabled(enabled);
return true;
}
return false;
}
private void applySelectedValue(JComboBox comboBox, Object value) {
comboBox.removeItemListener(this);
ValueLabelItem currentItem;
for (int i = 0; i < comboBox.getItemCount(); i++) {
currentItem = (ValueLabelItem) comboBox.getItemAt(i);
if (currentItem.getValue().equals(value)) {
comboBox.setSelectedIndex(i);
break;
}
}
comboBox.addItemListener(this);
}
}