eu.etaxonomy.taxeditor.store/src/main/java/eu/etaxonomy/taxeditor/ui/element/TextWithLabelElement.java

   1 /**
   2  *
   3  */
   4 package eu.etaxonomy.taxeditor.ui.element;
   5
   6 import org.eclipse.swt.SWT;
   7 import org.eclipse.swt.events.KeyAdapter;
   8 import org.eclipse.swt.events.KeyEvent;
   9 import org.eclipse.swt.events.ModifyEvent;
  10 import org.eclipse.swt.events.ModifyListener;
  11 import org.eclipse.swt.graphics.Color;
  12 import org.eclipse.swt.widgets.Composite;
  13 import org.eclipse.swt.widgets.Control;
  14 import org.eclipse.swt.widgets.Label;
  15 import org.eclipse.swt.widgets.Listener;
  16 import org.eclipse.swt.widgets.Text;
  17 import org.eclipse.ui.forms.widgets.TableWrapData;
  18
  19 import eu.etaxonomy.cdm.common.CdmUtils;
  20 import eu.etaxonomy.taxeditor.preference.Resources;
  21
  22 /**
  23  * @author n.hoffmann
  24  * @version $Id: $
  25  */
  26 public class TextWithLabelElement extends AbstractCdmFormElement implements ModifyListener, IEnableableFormElement,
  27         ISelectable {
  28
  29     protected Text text;
  30     private Label label;
  31
  32     private final boolean isMultiLine;
  33
  34     public static final int MAX_HEIGHT = 0;
  35     public static final int SINGLE = -1;
  36
  37     protected TextWithLabelElement(CdmFormFactory formFactory, ICdmFormElement parentElement, boolean isMultiLine) {
  38         super(formFactory, parentElement);
  39         this.isMultiLine = isMultiLine;
  40     }
  41
  42     protected TextWithLabelElement(CdmFormFactory formFactory, ICdmFormElement parentElement, String labelString,
  43             String initialText, Integer textHeight, int style) {
  44         this(formFactory, parentElement, labelString, initialText, textHeight, null, false, style);
  45     }
  46
  47     protected TextWithLabelElement(CdmFormFactory formFactory, ICdmFormElement parentElement, String labelString,
  48             String initialText, Integer textHeight, boolean isMultiLine, int style) {
  49         this(formFactory, parentElement, labelString, initialText, textHeight, null, isMultiLine, style);
  50     }
  51
  52     protected TextWithLabelElement(CdmFormFactory formFactory, ICdmFormElement parentElement, String labelString,
  53             String initialText, Integer textHeight, Integer textLimit, int style) {
  54         this(formFactory, parentElement, labelString, initialText, textHeight, textLimit, false, style);
  55     }
  56
  57     protected TextWithLabelElement(CdmFormFactory formFactory, ICdmFormElement parentElement, String labelString,
  58             String initialText, Integer textHeight, Integer textLimit, boolean isMultiLine, int style) {
  59         super(formFactory, parentElement);
  60
  61         this.isMultiLine = isMultiLine;
  62
  63         initLabel(formFactory, labelString, isMultiLine, getLayoutComposite());
  64
  65         initText(formFactory, initialText, textHeight, textLimit, isMultiLine, style, getLayoutComposite());
  66     }
  67
  68     protected void initText(CdmFormFactory formFactory, String initialText, Integer textHeight, Integer textLimit,
  69             boolean isMultiLine, int style, Composite layoutComposite) {
  70         int scrollStyle = textHeight == null ? SWT.NULL : (SWT.V_SCROLL | SWT.MULTI);
  71
  72         int combinedStyle = style | SWT.BORDER | scrollStyle;
  73
  74         // SWT.PASSWORD does not work when SWT.WRAP is set.
  75         if (style != SWT.PASSWORD) {
  76             combinedStyle = combinedStyle | SWT.WRAP;
  77         }
  78
  79         text = formFactory.createText(layoutComposite, "", combinedStyle);
  80         text.setTextLimit(textLimit!=null?textLimit:Text.LIMIT);
  81
  82         addControl(text);
  83
  84         // text.setWO
  85
  86         if (textHeight == null) {
  87             text.addKeyListener(new KeyAdapter() {
  88                 @Override
  89                 public void keyPressed(KeyEvent e) {
  90                     if (e.character == SWT.CR) {
  91                         // Don't accept carriage returns as input when in single
  92                         // line mode
  93                         e.doit = false;
  94                     } else if (e.character == SWT.TAB) {
  95                         // traverse is not working for wrapped text widgets so
  96                         // we reintroduce it here
  97                         e.doit = false;
  98                         TextWithLabelElement.this.text.traverse(SWT.TRAVERSE_TAB_NEXT);
  99                     }
 100                 }
 101             });
 102         }
 103
 104         TableWrapData layoutData;
 105         if(isMultiLine){
 106             layoutData = LayoutConstants.FILL_HORIZONTALLY(2, 1);
 107         }
 108         else{
 109             layoutData = LayoutConstants.FILL();
 110         }
 111         if (textHeight != null && textHeight > 0) {
 112             (layoutData).heightHint = textHeight;
 113         }
 114
 115         text.setLayoutData(layoutData);
 116
 117         text.addModifyListener(this);
 118
 119         setText(initialText);
 120     }
 121
 122     protected void initLabel(CdmFormFactory formFactory, String labelString, boolean isMultiLine, Composite layoutComposite) {
 123         if (labelString != null) {
 124             label = formFactory.createLabel(layoutComposite, CdmUtils.Nz(labelString), SWT.NULL);
 125             addControl(label);
 126             if(isMultiLine){
 127                 label.setLayoutData(LayoutConstants.FILL_HORIZONTALLY(2, 1));
 128                 ((TableWrapData)label.getLayoutData()).valign = TableWrapData.MIDDLE;
 129             }
 130             else{
 131                 label.setLayoutData(LayoutConstants.LEFT());
 132                 ((TableWrapData)label.getLayoutData()).valign = TableWrapData.MIDDLE;
 133             }
 134         }
 135     }
 136
 137     /**
 138      * Get the text of this composites text composite
 139      *
 140      * @return a {@link java.lang.String} object.
 141      */
 142     public String getText() {
 143
 144       return CdmUtils.Nb(text.getText());
 145     }
 146
 147     /**
 148      * Set the text of this composites text composite
 149      *
 150      * @param string
 151      *            a {@link java.lang.String} object.
 152      */
 153     public void setText(String string) {
 154         Listener[] listeners = text.getListeners(SWT.Modify);
 155
 156         for (Listener listener : listeners) {
 157             text.removeListener(SWT.Modify, listener);
 158         }
 159
 160         text.setText(CdmUtils.Nz(string));
 161
 162         for (Listener listener : listeners) {
 163             text.addListener(SWT.Modify, listener);
 164         }
 165     }
 166
 167     /** {@inheritDoc} */
 168     @Override
 169     public void modifyText(ModifyEvent e) {
 170         if(e.widget==text && !isMultiLine){
 171             Text text = (Text) e.widget;
 172             boolean hasControlCharacters = false;
 173             String textString = text.getText();
 174             int stringLength = textString.length();
 175             for (int i = 0; i < stringLength; i++) {
 176                 if (Character.isISOControl(textString.charAt(i))) {
 177                     hasControlCharacters = true;
 178                     break;
 179                 }
 180             }
 181             if(hasControlCharacters){
 182                 //remove control character such as line breaks etc.
 183                 setText(text.getText().replaceAll("\\p{C}", new Character((char)9608).toString()));
 184             }
 185         }
 186         firePropertyChangeEvent(new CdmPropertyChangeEvent(this, e));
 187     }
 188
 189     /** {@inheritDoc} */
 190     @Override
 191     public void setEnabled(boolean enabled) {
 192         text.setEnabled(enabled);
 193         String symbolicName = enabled ? Resources.COLOR_FONT_DEFAULT : Resources.COLOR_TEXT_DISABLED;
 194         text.setForeground(getColor(symbolicName));
 195     }
 196
 197     @Override
 198     public boolean isEnabled() {
 199         return text.isEnabled();
 200     }
 201
 202     /** {@inheritDoc} */
 203     @Override
 204     public void setIrrelevant(boolean irrelevant) {
 205         String colorId = irrelevant ? Resources.COLOR_COMPOSITE_IRRELEVANT : Resources.COLOR_COMPOSITE_BACKGROUND;
 206
 207         Color color = getColor(colorId);
 208         text.setBackground(color);
 209     }
 210
 211     /** {@inheritDoc} */
 212     @Override
 213     public void setBackground(Color color) {
 214         if (label != null) {
 215             label.setBackground(color);
 216         }
 217     }
 218
 219     @Override
 220     public void setSelected(boolean selected) {
 221         setBackground(selected ? SELECTED : getPersistentBackground());
 222     }
 223
 224     /** {@inheritDoc} */
 225     @Override
 226     public void setFocus() {
 227         text.setFocus();
 228     }
 229
 230     public Control getMainControl() {
 231         return text;
 232     }
 233
 234     public void setTextLimit(int limit) {
 235         text.setTextLimit(limit);
 236     }
 237
 238 }