org.gnu.gtk
Class Entry

java.lang.Object
  |
  +--org.gnu.glib.GObject
        |
        +--org.gnu.gtk.GtkObject
              |
              +--org.gnu.gtk.Widget
                    |
                    +--org.gnu.gtk.Editable
                          |
                          +--org.gnu.gtk.Entry
Direct Known Subclasses:
SpinButton

public class Entry
extends Editable

A single line text entry widget. A fairly large set of key bindings are supported by default. If the entered text is longer than the allocation of the widget, the widget will scroll so that the cursor position is visible.


Constructor Summary
Entry()
          Creates a new Entry widget.
Entry(int handle)
           
 
Method Summary
 void addListener(EntryListener listener)
          Register an object to handle spin events.
 java.lang.Class getEventListenerClass(java.lang.String signal)
           
 GtkEventType getEventType(java.lang.String signal)
           
 boolean getHasFrame()
          Gets the value set by setHasFrame(boolean).
 Layout getLayout()
          Gets the Layout used to display the entry.
 Point getLayoutOffsets()
          Obtains the position of the Layout used to render text in the entry, in widget coordinates.
 int getMaxLength()
          Returns the maximum length of the contents of the widget.
 java.lang.String getText()
          Retrieve the contents of the entry widget.
static Type getType()
          Retrieve the runtime type used by the GLib library.
 boolean getVisible()
          Retrieves whether the contents of the entry are visible or not.
 int getWidth()
          Gets the value set by setWidth(int).
 void removeListener(EntryListener listener)
          Removes a listener
 void setActivateDefaultWidget(boolean setting)
          If setting is TRUE, pressing Enter in the entry will activate the default widget for the window containing the entry.
 void setHasFrame(boolean setting)
          Sets whether the entry has a beveled frame around it.
 void setInvisibleChar(char character)
          Sets the character to use in place of the actual text when setVisibility has been called to set text visibility to FALSE.
 void setMaxLength(int max)
          Sets the maximum allowed length of the contents of the widget.
 void setText(java.lang.String text)
          Sets the text in the widget to the given value, replacing the current contents.
 void setVisible(boolean visible)
          Sets whether the contents of the entry are visible or not.
 void setWidth(int number)
          Changes the size request of the entry to be about the right size for number characters.
 
Methods inherited from class org.gnu.gtk.Editable
addListener, copyClipboard, cutClipboard, deleteSelection, deleteText, getCharacters, getCursorPosition, getEditable, insertText, pasteClipboard, removeListener, selectRegion, setCursorPosition, setEditable
 
Methods inherited from class org.gnu.gtk.Widget
activate, addListener, addListener, addListener, addListener, addListener, addListener, createContext, createLayout, destroy, draw, drawArea, drawArea, getAccessible, getColormap, getContext, getModifierStyle, getName, getParent, getParentWindow, getPointer, getSensitive, getStyle, getToplevel, grabDefault, grabFocus, hasFocus, hide, hideAll, intersect, isAncestor, makeWidget, modifyStyle, popColormap, pushColormap, realize, removeListener, removeListener, removeListener, removeListener, removeListener, removeListener, reparent, setBackgroundColor, setBaseColor, setColormap, setDoubleBuffered, setDragDestination, setDragSource, setFont, setForegroundColor, setMinimumSize, setName, setNoDragDestination, setNoDragSource, setSensitive, setTextColor, shapeCombineMask, show, showAll
 
Methods inherited from class org.gnu.glib.GObject
addEventHandler, addEventHandler, addEventHandler, addEventHandler, addEventHandler, addEventHandler, equals, getData, getHandle, removeEventHandler, setData
 
Methods inherited from class java.lang.Object
getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

Entry

public Entry()
Creates a new Entry widget.


Entry

public Entry(int handle)
Method Detail

setText

public void setText(java.lang.String text)
Sets the text in the widget to the given value, replacing the current contents.

Parameters:
text - The new text.

getText

public java.lang.String getText()
Retrieve the contents of the entry widget.

Returns:
the text of the widget

setVisible

public void setVisible(boolean visible)
Sets whether the contents of the entry are visible or not. When visibility is set to FALSE, characters are displayed as the invisible char, and will also appear that way when the text in the entry widget is copied elsewhere.

The default invisible char is the asterisk '*', but it can be changed with setInvisibleChar().


getVisible

public boolean getVisible()
Retrieves whether the contents of the entry are visible or not.


setInvisibleChar

public void setInvisibleChar(char character)
Sets the character to use in place of the actual text when setVisibility has been called to set text visibility to FALSE. i.e. this is the character used in "password mode" to show the user how many characters have been typed. The default invisible char is an asterisk ('*'). If you set the invisible char to 0, then the user will get no feedback at all; there will be no text on the screen as they type.


setMaxLength

public void setMaxLength(int max)
Sets the maximum allowed length of the contents of the widget. If the current contents are longer than the given length, then they will be truncated to fit.

Parameters:
max - The maximum length of the entry, or 0 for no maximum. (other than the maximum length of entries.) The value passed in will be clamped to the range 0-65536.

getMaxLength

public int getMaxLength()
Returns the maximum length of the contents of the widget.


getHasFrame

public boolean getHasFrame()
Gets the value set by setHasFrame(boolean).


getWidth

public int getWidth()
Gets the value set by setWidth(int).

Returns:
Number of chars to request space for, or negative if unset.

setActivateDefaultWidget

public void setActivateDefaultWidget(boolean setting)
If setting is TRUE, pressing Enter in the entry will activate the default widget for the window containing the entry. This usually means that the dialog box containing the entry will be closed, since the default widget is usually one of the dialog buttons.

Parameters:
setting - TRUE to activate window's default widget on Enter keypress

setHasFrame

public void setHasFrame(boolean setting)
Sets whether the entry has a beveled frame around it.


setWidth

public void setWidth(int number)
Changes the size request of the entry to be about the right size for number characters. Note that it changes the size request, the size can still be affected by how you pack the widget into containers. If n_chars is -1, the size reverts to the default entry size.

Parameters:
number - Width in Characters

getLayout

public Layout getLayout()
Gets the Layout used to display the entry. This layout is useful to convert text positions to pixel positions in combination with getLayoutOffsets.

Returns:
The PangoLayout for this entry

getLayoutOffsets

public Point getLayoutOffsets()
Obtains the position of the Layout used to render text in the entry, in widget coordinates. Useful if you want to line up the text in the entry with some other text, e.g. when using the entry to implement editable cells in a sheet widget.

Returns:
A Point identifying the x and y offset of the layout.

getType

public static Type getType()
Retrieve the runtime type used by the GLib library.


addListener

public void addListener(EntryListener listener)
Register an object to handle spin events.

See Also:
EntryListener

removeListener

public void removeListener(EntryListener listener)
Removes a listener

See Also:
addListener(EntryListener)

getEventListenerClass

public java.lang.Class getEventListenerClass(java.lang.String signal)
Overrides:
getEventListenerClass in class Editable

getEventType

public GtkEventType getEventType(java.lang.String signal)
Overrides:
getEventType in class Editable

Please send any bug reports, comments, or suggestions for the API or documentation to java-gnome-developer@lists.sf.net