Class pvWinJ.PVEdit 

java.lang.Object
   |
   +----java.awt.Component
           |
           +----java.awt.Canvas
                   |
                   +----pvWinJ.PVEdit
public class PVEdit
extends Canvas
implements Runnable

Class PVEdit is designed to edit one line text string.
It supports insert and overwrite edit modes, autoscroll, left/center/right text alignment and multiple painting styles.
All aspects of painting and edit mode behavior can be customized through get/setProperty().
Besides default system fonts like Arial, Courier, etc., the PVEdit has two build in LED fonts (thin and bold). The size of these fonts is adjusted automatically to fit in the height of the window rectangle. To enable this LED painting style, the get/setFontStyle() should be used.
Using the get/setOdometer() allows to create the cylinder appearance effect of the PVEdit background.

PVEdit supports TextListener, FocusListener, KeyListener, MouseListener and MouseMotionListener interfaces.

Example to insert an instance of the PVEdit class in an applet and set some properties:

public void init()
{
setSize(580, 650);
setLayout(null);
pvWinJ.PVEdit edit = new pvWinJ.PVEdit("PVEdit");
edit.setOdometer(pvWinJ.PVEdit.ODOMETER + 1);
edit.setBorder(pvWinJ.PVEdit.PICTURE + 256);
edit.setFontStyle(pvWinJ.PVEdit.LED_BOLD);
// edit.setFont(new Font("Courier", Font.BOLD | Font.ITALIC, 16));
edit.setBackColor(Color.lightGray);
edit.setAlignment(1);
edit.setText3D(new Dimension(-1, -1));
edit.setAlignment(2);
edit.setShadow(pvWinJ.PVEdit.RIGHT_BOTTOM);
edit.setShadowWidth(8);
add(edit);
edit.setBounds(5, 140, 260, 40);
...
}

Notes:
Use the get/setBackColor() to get/set background color rather than the get/setBackground() methods.
When fontStyle is set to a LED.., then text is painted by the LED build in font rather than the selected Font object.
When font with aureole is enabled, then the text 3D effect is disabled.

Variable Index

o FORMATTED
Constant to set text painting by selected font and with formatted spacing between characters.
o FORMATTED1
Constant to set text painting by selected font and with formatted spacing between characters and vertical lines.
o INDENT
Constant to set indent borders.
o LED
Constant to set text painting that resembles LED.
o LED_BOLD
Constant to set text painting that resembles LED with incresed thickness of segments.
o LEFT_BOTTOM
Constant to set shadow position to the left / bottom.
o LEFT_TOP
Constant to set shadow position to the left / top.
o NONE
Constant to set no border, or no shadow, or no odometer background.
o ODOMETER
Constant to set odometer background painting.
o ODOMETER_DARK
Constant to set dark odometer background painting.
o ODOMETER_LIGHT
Constant to set light odometer background painting.
o OUTDENT
Constant to set outdent borders.
o PICTURE
Constant to set picture borders.
o PLANE
Constant to set symmetric borders.
o RAISED
Constant to set raised borders.
o REGULAR
Constant to set text painting by selected font.
o RIGHT_BOTTOM
Constant to set shadow position to the right / bottom.
o RIGHT_TOP
Constant to set shadow position to the right / bottom.
o SUNKEN
Constant to set sunken borders.

Constructor Index

o PVEdit()
Contsructor.
o PVEdit(String)
Constructor.

Method Index

o addFocusListener(FocusListener)
Add focus listener to PVEdit.
o addKeyListener(KeyListener)
Add key listener to PVEdit.
o addMouseListener(MouseListener)
Add mouse listener to PVEdit.
o addMouseMotionListener(MouseMotionListener)
Add mouse motion listener to PVEdit.
o addTextListener(TextListener)
Add text listener to PVEdit.
o checkFocus()
Check owner of the input focus.
o getAlignment()
Get text alignment in window rectangle.
o getAureole()
Get an option to paint text with aureole.
o getAutoResize()
Get an option to autoadjust size of window rectangle.
o getAutoScroll()
Get an option for autoscroll.
o getBackColor()
Get background color of the client area.
o getBorder()
Get style of border painting.
o getBorderColor()
Get border color.
o getCaretPos()
Get current caret position.
o getCase()
Get the case of the text string.
o getChangeEditMode()
Get permission to change edit mode.
o getClientRect()
Get rectangle of client area.
o getEditable()
Text editing is enabled or disabled.
o getFontStyle()
Get style of text painting.
o getHighlightColor()
Get background color of the highlighted text.
o getInsertEditMode()
Get edit mode.
o getNumeric()
Get option to edit positive integers.
o getOdometer()
Get style of background painting.
o getSelectedText()
Get selected text string.
o getSelection()
Get start and end of the selected text.
o getSelectionOnFocus()
The option to set selection on gotFocus() event.
o getShadow()
Get shadow style.
o getShadowColor()
Get shadow color.
o getShadowWidth()
Get shadow width.
o getText()
Get current text string.
o getText3D()
Get text 3D effect.
o getText3DColor()
Get color of the text 3D (highlighted edges) effect or aureole.
o removeFocusListener(FocusListener)
Remove focus listener from PVEdit.
o removeKeyListener(KeyListener)
Remove key listener from PVEdit.
o removeMouseListener(MouseListener)
Remove mouse listener from PVEdit.
o removeMouseMotionListener(MouseMotionListener)
Remove mouse motion listener from PVEdit.
o removeTextListener(TextListener)
Remove text listener from PVEdit.
o setAlignment(int)
Set text alignment in the control window.
o setAureole(boolean)
Set an option to paint text with aureole.
o setAutoResize(boolean)
Set an option to autoadjust size of window rectangle on size change.
o setAutoScroll(boolean)
Set an option for autoscroll.
o setBackColor(Color)
Set background color of the client area.
o setBorder(int)
Set style of border painting.
o setBorderColor(Color)
Set border color.
o setCaretPos(int)
Set caret position.
o setCase(int)
Set the case of the text string.
o setChangeEditMode(boolean)
Set permission to change edit mode.
o setEditable(boolean)
Enable / disable text editing.
o setFontStyle(int)
Set style of text painting.
o setHighlightColor(Color)
Set the background color of the highlighted text.
o setInsertEditMode(boolean)
Set edit mode.
o setNumeric(int)
Convert PVEdit into editor of positive integers.
o setOdometer(int)
Set style of background painting.
o setSelection(Dimension)
Set text selection.
o setSelectionOnFocus(boolean)
The option to set selection on gotFocus() event.
o setShadow(int)
Set shadow style.
o setShadowColor(Color)
Set shadow color.
o setShadowWidth(int)
Set shadow width.
o setText(String)
Set current text string.
o setText3D(Dimension)
Set text 3D effect.
o setText3DColor(Color)
Set color of the text 3D (highlighted edges) effect, or aureole.

Variables

o NONE 

 public static final int NONE
Constant to set no border, or no shadow, or no odometer background.
Value is equal 0.
See Also:
setBorder, setShadow, setOdometer

o PLANE 

 public static final int PLANE
Constant to set symmetric borders.
Value is equal 1. It can be used with additional integer 1..9.
For example: PVEdit.PLANE + 4.
See Also:
setBorder

o RAISED 

 public static final int RAISED
Constant to set raised borders.
Value is equal 11. It can be used with additional integer 1..9.
For example: PVEdit.RAISED + 4.
See Also:
setBorder

o SUNKEN 

 public static final int SUNKEN
Constant to set sunken borders.
Value is equal 21. It can be used with additional integer 1..9.
For example: PVEdit.SUNKEN + 4.
See Also:
setBorder

o OUTDENT 

 public static final int OUTDENT
Constant to set outdent borders.
Value is equal 31. It can be used with additional integer 1..9.
For example: PVEdit.OUTDENT + 4.
See Also:
setBorder

o INDENT 

 public static final int INDENT
Constant to set indent borders.
Value is equal 41. It can be used with additional integer 1..9.
For example: PVEdit.INDENT + 4.
See Also:
setBorder

o PICTURE 

 public static final int PICTURE
Constant to set picture borders.
Value is equal 51. It can be used with additional integer 1..9.
For example: PVEdit.PICTURE + 4.
See Also:
setBorder

o REGULAR 

 public static final int REGULAR
Constant to set text painting by selected font.
Value is equal 0.
See Also:
setFontStyle

o FORMATTED 

 public static final int FORMATTED
Constant to set text painting by selected font and with formatted spacing between characters.
Value is equal 1.
See Also:
setFontStyle

o FORMATTED1 

 public static final int FORMATTED1
Constant to set text painting by selected font and with formatted spacing between characters and vertical lines. Value is equal 2.
See Also:
setFontStyle

o LED 

 public static final int LED
Constant to set text painting that resembles LED.
Value is equal 3.
See Also:
setFontStyle

o LED_BOLD 

 public static final int LED_BOLD
Constant to set text painting that resembles LED with incresed thickness of segments.
Value is equal 4.
See Also:
setFontStyle

o ODOMETER 

 public static final int ODOMETER
Constant to set odometer background painting.
Value is equal 4. It can be used with additional integer (1..2) to specify highlight position: 0 - top, 1 - center, 2 - bottom.
For example: PVEdit.ODOMETER + 1.
See Also:
setOdometer

o ODOMETER_LIGHT 

 public static final int ODOMETER_LIGHT
Constant to set light odometer background painting.
Value is equal 1. It can be used with additional integer (1..2) to specify highlight position: 0 - top, 1 - center, 2 - bottom.
For example: PVEdit.ODOMETER_LIGHT + 2.
See Also:
setOdometer

o ODOMETER_DARK 

 public static final int ODOMETER_DARK
Constant to set dark odometer background painting.
Value is equal 7. It can be used with additional integer (1..2) to specify highlight position: 0 - top, 1 - center, 2 - bottom.
For example: PVEdit.ODOMETER_DARK + 2.
See Also:
setOdometer

o RIGHT_BOTTOM 

 public static final int RIGHT_BOTTOM
Constant to set shadow position to the right / bottom.
Value is equal 1.
See Also:
setShadow

o LEFT_BOTTOM 

 public static final int LEFT_BOTTOM
Constant to set shadow position to the left / bottom.
Value is equal 2.
See Also:
setShadow

o LEFT_TOP 

 public static final int LEFT_TOP
Constant to set shadow position to the left / top.
Value is equal 3.
See Also:
setShadow

o RIGHT_TOP 

 public static final int RIGHT_TOP
Constant to set shadow position to the right / bottom.
Value is equal 4.
See Also:
setShadow

Constructors

o PVEdit 

 public PVEdit(String text)
Constructor.
Parameters:
text - the text string.
Other properties are set:
font - Arial, PLAIN, size 12;
fontStyle - 0(regular text);
border - 23(sunken);
odometer - 0(solid color);
insertEditMode - true;
changeEditMode - true;
editable - true;
selectionOnFocus - false;
alignment - 0(left justified);
autoScroll - true;
shadow - 0(no shadow);
shadowWidth - 5;
text3D horizontal - 0;
text3D vertical - 0;
case - 0;
numeric - 0;
foreground - black;
backColor - white;
borderColor - darker than the backColor;
highlightColor - dark blue;
shadowColor - darker than the background color;
text3DColor - green.
See Also:
setFontStyle, setOdometer, setBorder

o PVEdit 

 public PVEdit()
Contsructor.
It calls PVEdit("");

Methods

o getText 

 public String getText()
Get current text string.
Returns:
Text string.
See Also:
setText

o setText 

 public synchronized void setText(String text)
Set current text string.
Parameters:
text - new text string.

o getInsertEditMode 

 public boolean getInsertEditMode()
Get edit mode.
Returns:
An option.
See Also:
setInsertEditMode

o setInsertEditMode 

 public void setInsertEditMode(boolean insert)
Set edit mode.
Parameters:
insert - an option.
Value true - insert mode; false - overwrite mode.
Default value - true.
See Also:
getInsertEditMode

o getChangeEditMode 

 public boolean getChangeEditMode()
Get permission to change edit mode.
Returns:
An option.
See Also:
setChangeEditMode, getInsertEditMode

o setChangeEditMode 

 public void setChangeEditMode(boolean allow)
Set permission to change edit mode.
Parameters:
allow - an option.
Value true - allow to change edit mode (Insert key), false - do not allow to change edit mode.
Default value - true.
See Also:
getChangeEditMode

o getAutoResize 

 public boolean getAutoResize()
Get an option to autoadjust size of window rectangle.
Returns:
An option.
See Also:
setAutoResize

o setAutoResize 

 public void setAutoResize(boolean autoResize)
Set an option to autoadjust size of window rectangle on size change.
Parameters:
autoResize - an option.
Value true - autoResize on; false - no autoResize.
Default value - false.
Autoresize can be useful when formatted font style is used,- to fit character boxes in the width of window rectangle.
See Also:
getAutoResize, setFontStyle

o getAutoScroll 

 public boolean getAutoScroll()
Get an option for autoscroll.
Returns:
An option.
See Also:
setAutoScroll

o setAutoScroll 

 public void setAutoScroll(boolean autoScroll)
Set an option for autoscroll.
Parameters:
autoScroll - an option.
Value true - enable autoscroll, false - disable autoscroll.
Default value - true.
See Also:
getAutoScroll

o getSelectionOnFocus 

 public boolean getSelectionOnFocus()
The option to set selection on gotFocus() event.
Returns:
An option.
See Also:
setSelectionOnFocus, setSelection

o setSelectionOnFocus 

 public void setSelectionOnFocus(boolean selectAll)
The option to set selection on gotFocus() event.
Parameters:
selectAll - an option.
Value true - whole text is selected on gotFocus(), false - no selection.
Default value - false.
See Also:
setSelectionOnFocus, setSelection

o getEditable 

 public boolean getEditable()
Text editing is enabled or disabled.
Returns:
An option.
See Also:
setEditable

o setEditable 

 public void setEditable(boolean editable)
Enables / disables text editing.
Parameters:
editable - an option.
Value true - text is editable, false - text is not editable.
Default value - true.
See Also:
getEditable

o getFontStyle 

 public int getFontStyle()
Get style of text painting.
Returns:
Font style.
See Also:
setFontStyle

o setFontStyle 

 public void setFontStyle(int style)
Set style of text painting.
Parameters:
style - new style of text painting.
Range of values: 0..4.
See Also:
REGULAR, FORMATTED, FORMATTED1, LED, LED_BOLD, getFontStyle

o getAureole 

 public boolean getAureole()
Get an option to paint text with aureole.
Returns:
An option.
See Also:
setAureole, getFontStyle

o setAureole 

 public void setAureole(boolean aureole)
Set an option to paint text with aureole.
Parameters:
aureole - an option.
Value true - paints aureole around every character, horizontal and vertical text 3D effects are disabled. Value false - text painting with text 3D effect if any.
Default value - false.
Note: formatted text painting styles (getFontStyle = 1 or 2) do not support aureole.
See Also:
getAureole, getFontStyle, setText3DColor, setText3D

o getOdometer 

 public int getOdometer()
Get style of background painting.
Returns:
Style of background painting.
See Also:
setOdometer

o setOdometer 

 public void setOdometer(int style)
Set style of background painting.
Parameters:
style - new style of background painting.
Default value is set to 0.
Range of values: 0..9.
0 - no odometer shadows, background is painted by solid selected background color, all other values define odometer style painting.
The color of the odometer is based on the selected background color and "dark shadows" are shifted to the black color. Painting can be performed with different levels of shadow deph and position.
Example:
// draw dark odometer with highlighted area at the center
pvEdit1.setOdometer(PVEdit.ODOMETER_DARK + 1);
See Also:
NONE, ODOMETER, ODOMETER_LIGHT, ODOMETER_DARK, getOdometer, setBackColor

o getBorder 

 public int getBorder()
Get style of border painting.
Returns:
Border style.
See Also:
setBorder

o setBorder 

 public void setBorder(int style)
Set style of border painting.
Parameters:
style - new border style.
It combines actual border style and thickness factor, which allows to increase width of selected border style.
Lower byte (0x00XX) defines border style (range: 0..60).
This styles can be subdivided on 7 main groups:
0, 1..10, 11..20, ...51..60. There are seven constants for each group.
Style can be built using these constants and additional integer (1..9).
Second byte (0x0X00) defines thicknes factor (range: 0..7). Value "0" means regular style defined by the first byte. Values 1..7 will increase thickness in 2..8 times.
Examples:
// this will draw the first type of the border from the PICTURE group.
pvEdit1.setBorder(PVEdit.PICTURE); // or "51"
// this will draw the 8th type of border from the PLANE group with triple thickness.
pvEdit1.setBorder((PVEdit.PLANE + 8) | 0x200); // or "0x209"
Default value is set to 23 (PVEdit.SUNKEN + 2).
See Also:
NONE, PLANE, RAISED, SUNKEN, INDENT, OUTDENT, PICTURE, getBorder

o getShadow 

 public int getShadow()
Get shadow style.
Returns:
Shadow style.
See Also:
setShadow

o setShadow 

 public void setShadow(int style)
Set shadow style.
Parameters:
style - new shadow style.
See Also:
NONE, RIGHT_BOTTOM, LEFT_BOTTOM, RIGHT_TOP, LEFT_TOP, getShadow

o getShadowWidth 

 public int getShadowWidth()
Get shadow width.
Returns:
Shadow width in pixels.
See Also:
setShadowWidth

o setShadowWidth 

 public void setShadowWidth(int width)
Set shadow width.
Parameters:
width - new shadow width in pixels.
Range: 0..20.
Default value is set to 5 (pixels).
Note: to paint the shadow, the getShadow() should not be equal 0.
See Also:
getShadowWidth

o getAlignment 

 public int getAlignment()
Get text alignment in the control window.
Returns:
Horizontal text alignment in control window.
See Also:
setAlignment

o setAlignment 

 public void setAlignment(int alignment)
Set text alignment in the control window.
Parameters:
alignment - horizontal text alignment.
0 - left justified,
1 - center justified,
2 - right justified.
Default value is set to 0 - left justified.
See Also:
getAlignment

o setCase 

 public void setCase(int stringCase)
Set the case of the text string.
Parameters:
stringCase - an option.
Possible values:
0 - text string is not modified.
1 - text string is converted to the upper case.
2 - text string is converted to the lower case.
Default value is set to 0.
See Also:
getCase

o getCase 

 public int getCase()
Get the case of the text string.
Returns:
An option.
See Also:
setCase

o getCaretPos 

 public int getCaretPos()
Get current caret position.
Returns:
Current caret position.
See Also:
setCaretPos

o setCaretPos 

 public void setCaretPos(int caretPosition)
Set caret position.
Parameters:
caretPosition - caret position in text.
Possible values: 0 - first character position in the text string, maximum value - the length of the text.
See Also:
getCaretPos

o getText3D 

 public Dimension getText3D()
Get text 3D effect.
Returns:
Horizontal and vertical text 3D effect.
See Also:
setText3D

o setText3D 

 public void setText3D(Dimension text3D)
Set text 3D effect.
If the aureole is enabled, then this text3D effect is disabled.
Parameters:
text3D.width - horizontal shift of the text 3D from the main text in pixels.
text3D.height - vertical shift of the text 3D from the main text in pixels.
Range of shifts is -4..4 pixels.
Default value is set to the (0, 0).
Example:
pvEdit1.setText3D(new Dimension(-1, -1));
See Also:
getText3D, setText3DColor, setAureole, setFontStyle

o getBackColor 

 public Color getBackColor()
Get background color of the client area.
Returns:
Color.
See Also:
setBackColor

o setBackColor 

 public void setBackColor(Color color)
Set background color of the client area.
Parameters:
color - color of the client area.
If it is set to the "null", then the color that is lighter than the background color is used.
Default value is set to the white color.
See Also:
getBackColor, setShadow

o getHighlightColor 

 public Color getHighlightColor()
Get background color of the highlighted text.
Returns:
Color.
See Also:
setHighlightColor

o setHighlightColor 

 public void setHighlightColor(Color color)
Set the background color of the highlighted text.
Parameters:
color - background of the highlighted text.
If it is set to the "null", then the foreground color is used.
Default value is set to the dark blue color (rgb=0xff000080).
See Also:
getHighlightColor

o getBorderColor 

 public Color getBorderColor()
Get border color.
Returns:
Color.
See Also:
setBorderColor

o setBorderColor 

 public void setBorderColor(Color color)
Set border color.
Parameters:
color - new border color.
If it is set to the "null", then the color that is darker than the backColor is used.
Default value is set to the color that is darker than the backColor (null).
See Also:
getBorderColor, setBackColor

o getText3DColor 

 public Color getText3DColor()
Get color of the text 3D (highlighted edges) effect or aureole.
Returns:
Color.
See Also:
setText3DColor

o setText3DColor 

 public void setText3DColor(Color color)
Set color of the text 3D (highlighted edges) effect, or aureole.
Parameters:
color - color of the text 3D.
If it is set to the "null", then the color that is darker than the backColor is used.
Default value is set to the green color.
See Also:
getText3DColor

o getShadowColor 

 public Color getShadowColor()
Get shadow color.
Returns:
Color.
See Also:
setShadowColor

o setShadowColor 

 public void setShadowColor(Color color)
Set shadow color.
Parameters:
color - color of the window's shadow.
If it is set to the "null", then the color that is darker than the background color is used.
Default value is set to the color darker than the background color (null).
See Also:
getShadowColor

o getSelectedText 

 public String getSelectedText()
Get selected text string.
Returns:
Selected text.
See Also:
getText, getSelection

o getSelection 

 public Dimension getSelection()
Get start and end of the selected text.
Returns:
The beginning and the end of the text selection in terms of character count starting from the beginning of the text string.
ReturnValue.width - start selection, ReturnValue.height - end selection.
See Also:
setSelection, getSelectedText

o setSelection 

 public void setSelection(Dimension selection)
Set text selection.
Parameters:
selection.width defines the start of selection;
selection.height - the end of selection.
See Also:
getSelection, getSelectedText

o getClientRect 

 public Rectangle getClientRect()
Get rectangle of client area.
Returns:
Client rectangle area without border and shadow.

o setNumeric 

 public void setNumeric(int maxValue)
Convert PVEdit into editor of a string that represents a positive integer.
Notes:
It also sets edit mode to insert, autoScroll to false, selectionOnFocus to true, changeEditMode to false.
Though this method is designed for internal purposes and has some restrictions it can be used (with caution).
Don't use it for any derived class, only for the PVEdit.
Don't change edit mode,
Don't setText that is not positive integer or larger than maxValue.
Parameters:
maxValue - maximum value of integer.
To disable that behavior set the maxValue to 0.
See Also:
getNumeric

o getNumeric 

 public int getNumeric()
Get an option to edit a string that represents a positive integer.
Returns:
Maximum value of integer.
See Also:
setNumeric

o checkFocus 

 public int checkFocus()
Check owner of the input focus.
Returns:
State of focus.
0 - no focus.
1 - focus is just received (0..200 ms).
2 - focus is on (longer than 200 ms).

o addFocusListener 

 public synchronized void addFocusListener(FocusListener fl)
Overrides:
addFocusListener in class Component

o removeFocusListener 

 public synchronized void removeFocusListener(FocusListener fl)
Overrides:
removeFocusListener in class Component

o addMouseListener 

 public synchronized void addMouseListener(MouseListener ml)
Example how to use the MouseListener with an instance of the PVEdit:
pvedit1.addMouseListener(new MouseListener()
        {
            public void mouseExited(MouseEvent e)
            { System.err.println("exit");}
            public void mouseEntered(MouseEvent e)
            { System.err.println("enter");}
            public void mouseClicked(MouseEvent e)
            { System.err.println("click");}
            public void mousePressed(MouseEvent e)
            { System.err.println("press");}
            public void mouseReleased(MouseEvent e)
            { System.err.println("release");}
        });
Overrides:
addMouseListener in class Component

o removeMouseListener 

 public synchronized void removeMouseListener(MouseListener ml)
Overrides:
removeMouseListener in class Component

o addKeyListener 

 public synchronized void addKeyListener(KeyListener kl)
Overrides:
addKeyListener in class Component

o removeKeyListener 

 public synchronized void removeKeyListener(KeyListener kl)
Overrides:
removeKeyListener in class Component

o addTextListener 

 public synchronized void addTextListener(TextListener tl)

o removeTextListener 

 public synchronized void removeTextListener(TextListener tl)

o addMouseMotionListener 

 public synchronized void addMouseMotionListener(MouseMotionListener ml)
Example how to use the MouseMotionListener with an instance of the PVEdit:
pvedit1.addMouseListener(new MouseListener()
        {
            public void mouseMoved(MouseEvent e)
            { System.err.println("move");}
            public void mouseDragged(MouseEvent e)
            { System.err.println("drag");}
        });
Overrides:
addMouseMotionListener in class Component

o removeMouseMotionListener 

 public synchronized void removeMouseMotionListener(MouseMotionListener ml)
Overrides:
removeMouseMotionListener in class Component