package org.openswing.swing.client;
import java.awt.*;
import java.awt.event.*;
import javax.swing.*;
import org.openswing.swing.util.client.ClientSettings;
/**
* <p>Title: OpenSwing Framework</p>
* <p>Description: Text Area control.</p>
* <p>Copyright: Copyright (C) 2006 Mauro Carniel</p>
*
* <p> This file is part of OpenSwing Framework.
* This library is free software; you can redistribute it and/or
* modify it under the terms of the (LGPL) Lesser General Public
* License as published by the Free Software Foundation;
*
* GNU LESSER GENERAL PUBLIC LICENSE
* Version 2.1, February 1999
*
* This library is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
* Library General Public License for more details.
*
* You should have received a copy of the GNU Library General Public
* License along with this library; if not, write to the Free
* Software Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
*
* The author may be contacted at:
* maurocarniel@tin.it</p>
*
* @author Mauro Carniel
* @version 1.0
*/
public class TextAreaControl extends BaseInputControl implements InputControl {
/** maximum number of characters */
private int maxCharacters = 255;
/** used by addNotify method */
private JScrollPane scrollPane = new JScrollPane();
/** text editor */
private TextArea textArea = new TextArea();
/**
* Constructor.
* @param columns number of visibile characters
*/
public TextAreaControl() {
scrollPane.getViewport().add(textArea,null);
this.setLayout(new BorderLayout(0,0));
this.add(scrollPane,BorderLayout.CENTER);
textArea.setFont(UIManager.getFont("TextField.font"));
if (ClientSettings.TEXT_ORIENTATION!=null)
setComponentOrientation(ClientSettings.TEXT_ORIENTATION);
addFocusListener();
addKeyListener();
initListeners();
}
/**
* Create a key listener to correcly set the content of the control.
*/
private void addKeyListener() {
textArea.addKeyListener(new KeyAdapter() {
public final void keyReleased(KeyEvent e) {
e.consume();
}
public final void keyTyped(KeyEvent e) {
if (textArea.getText()!=null &&
textArea.getSelectedText()==null &&
textArea.getText().length()>=maxCharacters &&
e.getKeyChar()!='\b') {
textArea.setText(textArea.getText().substring(0,maxCharacters));
e.consume();
}
else if (textArea.getText()!=null &&
textArea.getSelectedText()!=null &&
e.getKeyChar()!='\b' &&
textArea.getText().length()-textArea.getSelectedText().length()>=maxCharacters) {
textArea.setText(textArea.getText().substring(0,maxCharacters));
e.consume();
}
}
public void keyPressed(KeyEvent e) {
if (e.getKeyCode()==e.VK_TAB) {
e.consume();
textArea.transferFocus();
}
}
});
}
/**
* Set maximum number of characters.
* @param maxCharacters maximum number of characters
*/
public void setMaxCharacters(int maxCharacters) {
this.maxCharacters = maxCharacters;
}
/**
* @return maximum number of characters
*/
public int getMaxCharacters() {
return maxCharacters;
}
/**
* Create a focus listener to correcly set the content of the control.
*/
private void addFocusListener() {
textArea.addFocusListener(new FocusAdapter() {
public void focusLost(FocusEvent e) {
if (textArea.isEnabled() && textArea.isEditable()) {
textArea.setText(textArea.getText());
}
}
});
}
public final void setText(String text) {
if (text==null)
text = "";
if (text.length()>maxCharacters)
text = text.substring(0,maxCharacters);
textArea.setText(text);
}
/**
* Replace enabled setting with editable setting (this allow tab swithing).
* @param enabled flag used to set abilitation of control
*/
public void setEnabled(boolean enabled) {
textArea.setEditable(enabled);
textArea.setFocusable(enabled || ClientSettings.DISABLED_INPUT_CONTROLS_FOCUSABLE);
if (enabled)
textArea.setBackground((Color)UIManager.get("TextField.background"));
else
textArea.setBackground((Color)UIManager.get("TextField.inactiveBackground"));
}
/**
* @return current input control abilitation
*/
public final boolean isEnabled() {
try {
return textArea.isEditable();
}
catch (Exception ex) {
return false;
}
}
/**
* @return text editor
*/
public final JTextArea getTextArea() {
return textArea;
}
/**
* @return component inside this whose contains the value
*/
public JComponent getBindingComponent() {
return textArea;
}
/**
* @return value related to the input control
*/
public Object getValue() {
if (textArea.getText()!=null && textArea.getText().length()==0)
return null;
return textArea.getText();
}
/**
* Set value to the input control.
* @param value value to set into the input control
*/
public void setValue(Object value) {
textArea.setText((String)value);
}
/**
* Set the component orientation: from left to right or from right to left.
* @param o component orientation
*/
public final void setTextOrientation(ComponentOrientation o) {
textArea.setComponentOrientation(o);
}
/**
* @return component orientation
*/
public final ComponentOrientation getTextOrientation() {
try {
return textArea.getComponentOrientation();
}
catch (Exception ex) {
return null;
}
}
/**
* Adds the specified focus listener to receive focus events from
* this component when this component gains input focus.
* If listener <code>l</code> is <code>null</code>,
* no exception is thrown and no action is performed.
*
* @param l the focus listener
* @see java.awt.event.FocusEvent
* @see java.awt.event.FocusListener
* @see #removeFocusListener
* @see #getFocusListeners
* @since JDK1.1
*/
public final void addFocusListener(FocusListener listener) {
try {
textArea.addFocusListener(listener);
}
catch (Exception ex) {
}
}
/**
* Removes the specified focus listener so that it no longer
* receives focus events from this component. This method performs
* no function, nor does it throw an exception, if the listener
* specified by the argument was not previously added to this component.
* If listener <code>l</code> is <code>null</code>,
* no exception is thrown and no action is performed.
*
* @param l the focus listener
* @see java.awt.event.FocusEvent
* @see java.awt.event.FocusListener
* @see #addFocusListener
* @see #getFocusListeners
* @since JDK1.1
*/
public final void removeFocusListener(FocusListener listener) {
try {
textArea.removeFocusListener(listener);
}
catch (Exception ex) {
}
}
public void processKeyEvent(KeyEvent e) {
try {
textArea.processKeyEvent(e);
}
catch (Throwable ex) {
}
}
/**
* Selects the text between the specified start and end positions.
* <p>
* This method sets the start and end positions of the
* selected text, enforcing the restriction that the start position
* must be greater than or equal to zero. The end position must be
* greater than or equal to the start position, and less than or
* equal to the length of the text component's text.
* <p>
* If the caller supplies values that are inconsistent or out of
* bounds, the method enforces these constraints silently, and
* without failure. Specifically, if the start position or end
* position is greater than the length of the text, it is reset to
* equal the text length. If the start position is less than zero,
* it is reset to zero, and if the end position is less than the
* start position, it is reset to the start position.
* <p>
* This call is provided for backward compatibility.
* It is routed to a call to <code>setCaretPosition</code>
* followed by a call to <code>moveCaretPosition</code>.
* The preferred way to manage selection is by calling
* those methods directly.
*
* @param selectionStart the start position of the text
* @param selectionEnd the end position of the text
* @see #setCaretPosition
* @see #moveCaretPosition
*/
public final void select(int selectionStart,int selectionEnd) {
textArea.select(selectionStart,selectionEnd);
}
class TextArea extends JTextArea {
public void setEnabled(boolean enabled) {
TextAreaControl.this.setEnabled(enabled);
}
public void processKeyEvent(KeyEvent e) {
super.processKeyEvent(e);
}
};
}