org.gnu.gtk

Class Entry

Implemented Interfaces:
Editable
Known Direct Subclasses:
SpinButton

public class Entry
extends Widget
implements 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()
Deprecated. Superceeded by java-gnome 4.0; a method along these lines may well exist in the new bindings, but if it does it likely has a different name or signature due to the shift to an algorithmic mapping of the underlying native libraries.
Entry(Handle handle)
Deprecated. Superceeded by java-gnome 4.0; a method along these lines may well exist in the new bindings, but if it does it likely has a different name or signature due to the shift to an algorithmic mapping of the underlying native libraries.

Method Summary

void
addListener(EntryListener listener)
Deprecated. Superceeded by java-gnome 4.0; a method along these lines may well exist in the new bindings, but if it does it likely has a different name or signature due to the shift to an algorithmic mapping of the underlying native libraries.
void
copyClipboard()
void
cutClipboard()
void
deleteSelection()
void
deleteText(int start, int end)
float
getAlignment()
Deprecated. Superceeded by java-gnome 4.0; a method along these lines may well exist in the new bindings, but if it does it likely has a different name or signature due to the shift to an algorithmic mapping of the underlying native libraries.
String
getCharacters(int start, int end)
EntryCompletion
getCompletion()
int
getCursorPosition()
boolean
getEditable()
static Entry
getEntry(Handle handle)
Deprecated. Superceeded by java-gnome 4.0; a method along these lines may well exist in the new bindings, but if it does it likely has a different name or signature due to the shift to an algorithmic mapping of the underlying native libraries.
Class
getEventListenerClass(String signal)
EventType
getEventType(String signal)
boolean
getHasFrame()
Deprecated. Superceeded by java-gnome 4.0; a method along these lines may well exist in the new bindings, but if it does it likely has a different name or signature due to the shift to an algorithmic mapping of the underlying native libraries.
Layout
getLayout()
Deprecated. Superceeded by java-gnome 4.0; a method along these lines may well exist in the new bindings, but if it does it likely has a different name or signature due to the shift to an algorithmic mapping of the underlying native libraries.
Point
getLayoutOffsets()
Deprecated. Superceeded by java-gnome 4.0; a method along these lines may well exist in the new bindings, but if it does it likely has a different name or signature due to the shift to an algorithmic mapping of the underlying native libraries.
int
getMaxLength()
Deprecated. Superceeded by java-gnome 4.0; a method along these lines may well exist in the new bindings, but if it does it likely has a different name or signature due to the shift to an algorithmic mapping of the underlying native libraries.
String
getText()
Deprecated. Superceeded by java-gnome 4.0; a method along these lines may well exist in the new bindings, but if it does it likely has a different name or signature due to the shift to an algorithmic mapping of the underlying native libraries.
static Type
getType()
Deprecated. Superceeded by java-gnome 4.0; a method along these lines may well exist in the new bindings, but if it does it likely has a different name or signature due to the shift to an algorithmic mapping of the underlying native libraries.
boolean
getVisible()
Deprecated. Superceeded by java-gnome 4.0; a method along these lines may well exist in the new bindings, but if it does it likely has a different name or signature due to the shift to an algorithmic mapping of the underlying native libraries.
int
getWidth()
Deprecated. Superceeded by java-gnome 4.0; a method along these lines may well exist in the new bindings, but if it does it likely has a different name or signature due to the shift to an algorithmic mapping of the underlying native libraries.
void
handleToggleOverwrite()
int
insertText(String text, int offset)
int
layoutIndexToTextIndex(int layoutIndex)
Deprecated. Superceeded by java-gnome 4.0; a method along these lines may well exist in the new bindings, but if it does it likely has a different name or signature due to the shift to an algorithmic mapping of the underlying native libraries.
void
pasteClipboard()
void
removeListener(EntryListener listener)
Deprecated. Superceeded by java-gnome 4.0; a method along these lines may well exist in the new bindings, but if it does it likely has a different name or signature due to the shift to an algorithmic mapping of the underlying native libraries.
void
selectRegion(int start, int end)
Methods from Editable
void
setActivateDefaultWidget(boolean setting)
Deprecated. Superceeded by java-gnome 4.0; a method along these lines may well exist in the new bindings, but if it does it likely has a different name or signature due to the shift to an algorithmic mapping of the underlying native libraries.
void
setAlignment(float xalign)
Deprecated. Superceeded by java-gnome 4.0; a method along these lines may well exist in the new bindings, but if it does it likely has a different name or signature due to the shift to an algorithmic mapping of the underlying native libraries.
void
setCompletion(EntryCompletion completion)
void
setCursorPosition(int position)
void
setEditable(boolean isEditable)
void
setHasFrame(boolean setting)
Deprecated. Superceeded by java-gnome 4.0; a method along these lines may well exist in the new bindings, but if it does it likely has a different name or signature due to the shift to an algorithmic mapping of the underlying native libraries.
void
setInvisibleChar(char character)
Deprecated. Superceeded by java-gnome 4.0; a method along these lines may well exist in the new bindings, but if it does it likely has a different name or signature due to the shift to an algorithmic mapping of the underlying native libraries.
void
setMaxLength(int max)
Deprecated. Superceeded by java-gnome 4.0; a method along these lines may well exist in the new bindings, but if it does it likely has a different name or signature due to the shift to an algorithmic mapping of the underlying native libraries.
void
setText(String text)
Deprecated. Superceeded by java-gnome 4.0; a method along these lines may well exist in the new bindings, but if it does it likely has a different name or signature due to the shift to an algorithmic mapping of the underlying native libraries.
void
setVisible(boolean visible)
Deprecated. Superceeded by java-gnome 4.0; a method along these lines may well exist in the new bindings, but if it does it likely has a different name or signature due to the shift to an algorithmic mapping of the underlying native libraries.
void
setWidth(int number)
Deprecated. Superceeded by java-gnome 4.0; a method along these lines may well exist in the new bindings, but if it does it likely has a different name or signature due to the shift to an algorithmic mapping of the underlying native libraries.
int
textIndexToLayoutIndex(int textIndex)
Deprecated. Superceeded by java-gnome 4.0; a method along these lines may well exist in the new bindings, but if it does it likely has a different name or signature due to the shift to an algorithmic mapping of the underlying native libraries.

Methods inherited from class org.gnu.gtk.Widget

activate, addAccelerator, addEvents, addListener, addListener, addListener, addListener, addListener, addListener, addListener, addListener, addListener, addListener, addListener, canActivateAccel, createContext, createLayout, draw, drawArea, drawArea, finish, getAccessible, getAllocation, getCanFocus, getColormap, getContext, getData, getDisplay, getDragData, getEventListenerClass, getEventType, getExtensionEvents, getModifierStyle, getName, getParent, getParentWindow, getPointer, getRootWindow, getScreen, getSensitive, getStyle, getToplevel, getType, getWidget, getWindow, grabDefault, grabFocus, hasFocus, hasScreen, hide, hideAll, highlight, highlight, intersect, isAncestor, makeWidget, modifyStyle, popColormap, pushColormap, realize, removeAccelerator, removeListener, removeListener, removeListener, removeListener, removeListener, removeListener, removeListener, removeListener, removeListener, removeListener, removeListener, reparent, setBackgroundColor, setBaseColor, setCanFocus, setColormap, setDoubleBuffered, setDragDestination, setDragIcon, setDragIconPixbuf, setDragIconStock, setDragSource, setEvents, setExtensionEvents, setFont, setForegroundColor, setMinimumSize, setName, setNoDragDestination, setNoDragSource, setSensitive, setTextColor, shapeCombineMask, show, showAll, unHighlight, unHighlight

Methods inherited from class org.gnu.gtk.GtkObject

destroy, getType, sink

Constructor Details

Entry

public Entry()

Deprecated. Superceeded by java-gnome 4.0; a method along these lines may well exist in the new bindings, but if it does it likely has a different name or signature due to the shift to an algorithmic mapping of the underlying native libraries.

Creates a new Entry widget.

Entry

public Entry(Handle handle)

Deprecated. Superceeded by java-gnome 4.0; a method along these lines may well exist in the new bindings, but if it does it likely has a different name or signature due to the shift to an algorithmic mapping of the underlying native libraries.

Create a new Widget with a handle to a native resource returned from a call to the native libraries.
Parameters:
handle - The handle that represents a pointer to a native resource.

Method Details

addListener

public void addListener(EntryListener listener)

Deprecated. Superceeded by java-gnome 4.0; a method along these lines may well exist in the new bindings, but if it does it likely has a different name or signature due to the shift to an algorithmic mapping of the underlying native libraries.

Register an object to handle spin events.
See Also:
EntryListener

copyClipboard

public void copyClipboard()
Specified by:
copyClipboard in interface Editable

cutClipboard

public void cutClipboard()
Specified by:
cutClipboard in interface Editable

deleteSelection

public void deleteSelection()
Specified by:
deleteSelection in interface Editable

deleteText

public void deleteText(int start,
                       int end)
Specified by:
deleteText in interface Editable

getAlignment

public float getAlignment()

Deprecated. Superceeded by java-gnome 4.0; a method along these lines may well exist in the new bindings, but if it does it likely has a different name or signature due to the shift to an algorithmic mapping of the underlying native libraries.


getCharacters

public String getCharacters(int start,
                            int end)
Specified by:
getCharacters in interface Editable

getCompletion

public EntryCompletion getCompletion()

getCursorPosition

public int getCursorPosition()
Specified by:
getCursorPosition in interface Editable

getEditable

public boolean getEditable()
Specified by:
getEditable in interface Editable

getEntry

public static Entry getEntry(Handle handle)

Deprecated. Superceeded by java-gnome 4.0; a method along these lines may well exist in the new bindings, but if it does it likely has a different name or signature due to the shift to an algorithmic mapping of the underlying native libraries.

Internal static factory method to be used by Java-Gnome only.

getEventListenerClass

public Class getEventListenerClass(String signal)
Overrides:
getEventListenerClass in interface Widget

getEventType

public EventType getEventType(String signal)
Overrides:
getEventType in interface Widget

getHasFrame

public boolean getHasFrame()

Deprecated. Superceeded by java-gnome 4.0; a method along these lines may well exist in the new bindings, but if it does it likely has a different name or signature due to the shift to an algorithmic mapping of the underlying native libraries.


getLayout

public Layout getLayout()

Deprecated. Superceeded by java-gnome 4.0; a method along these lines may well exist in the new bindings, but if it does it likely has a different name or signature due to the shift to an algorithmic mapping of the underlying native libraries.

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()

Deprecated. Superceeded by java-gnome 4.0; a method along these lines may well exist in the new bindings, but if it does it likely has a different name or signature due to the shift to an algorithmic mapping of the underlying native libraries.

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.

getMaxLength

public int getMaxLength()

Deprecated. Superceeded by java-gnome 4.0; a method along these lines may well exist in the new bindings, but if it does it likely has a different name or signature due to the shift to an algorithmic mapping of the underlying native libraries.

Returns the maximum length of the contents of the widget.

getText

public String getText()

Deprecated. Superceeded by java-gnome 4.0; a method along these lines may well exist in the new bindings, but if it does it likely has a different name or signature due to the shift to an algorithmic mapping of the underlying native libraries.

Retrieve the contents of the entry widget.
Returns:
the text of the widget

getType

public static Type getType()

Deprecated. Superceeded by java-gnome 4.0; a method along these lines may well exist in the new bindings, but if it does it likely has a different name or signature due to the shift to an algorithmic mapping of the underlying native libraries.

Retrieve the runtime type used by the GLib library.
Overrides:
getType in interface Widget

getVisible

public boolean getVisible()

Deprecated. Superceeded by java-gnome 4.0; a method along these lines may well exist in the new bindings, but if it does it likely has a different name or signature due to the shift to an algorithmic mapping of the underlying native libraries.

Retrieves whether the contents of the entry are visible or not.

getWidth

public int getWidth()

Deprecated. Superceeded by java-gnome 4.0; a method along these lines may well exist in the new bindings, but if it does it likely has a different name or signature due to the shift to an algorithmic mapping of the underlying native libraries.

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

handleToggleOverwrite

public void handleToggleOverwrite()

insertText

public int insertText(String text,
                      int offset)
Specified by:
insertText in interface Editable

layoutIndexToTextIndex

public int layoutIndexToTextIndex(int layoutIndex)

Deprecated. Superceeded by java-gnome 4.0; a method along these lines may well exist in the new bindings, but if it does it likely has a different name or signature due to the shift to an algorithmic mapping of the underlying native libraries.

Converts from a position in the entry contents (returned by getText()) to a position in the entry's PangoLayout (returned by getLayout(), with text retrieved via Layout.getText()).

pasteClipboard

public void pasteClipboard()
Specified by:
pasteClipboard in interface Editable

removeListener

public void removeListener(EntryListener listener)

Deprecated. Superceeded by java-gnome 4.0; a method along these lines may well exist in the new bindings, but if it does it likely has a different name or signature due to the shift to an algorithmic mapping of the underlying native libraries.

Removes a listener

selectRegion

public void selectRegion(int start,
                         int end)
Methods from Editable
Specified by:
selectRegion in interface Editable

setActivateDefaultWidget

public void setActivateDefaultWidget(boolean setting)

Deprecated. Superceeded by java-gnome 4.0; a method along these lines may well exist in the new bindings, but if it does it likely has a different name or signature due to the shift to an algorithmic mapping of the underlying native libraries.

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

setAlignment

public void setAlignment(float xalign)

Deprecated. Superceeded by java-gnome 4.0; a method along these lines may well exist in the new bindings, but if it does it likely has a different name or signature due to the shift to an algorithmic mapping of the underlying native libraries.

Sets the alignment for the contents of the entry. This controls the horizontal positioning of the contents when the displayed text is shorter than the width of the entry.
Parameters:
xalign - The horizontal alignment, from 0 (left) to 1 (right). Reversed for RTL layouts.

setCompletion

public void setCompletion(EntryCompletion completion)

setCursorPosition

public void setCursorPosition(int position)
Specified by:
setCursorPosition in interface Editable

setEditable

public void setEditable(boolean isEditable)
Specified by:
setEditable in interface Editable

setHasFrame

public void setHasFrame(boolean setting)

Deprecated. Superceeded by java-gnome 4.0; a method along these lines may well exist in the new bindings, but if it does it likely has a different name or signature due to the shift to an algorithmic mapping of the underlying native libraries.

Sets whether the entry has a beveled frame around it.

setInvisibleChar

public void setInvisibleChar(char character)

Deprecated. Superceeded by java-gnome 4.0; a method along these lines may well exist in the new bindings, but if it does it likely has a different name or signature due to the shift to an algorithmic mapping of the underlying native libraries.

Sets the character to use in place of the actual text when setVisibility has been called to set text visibility to FALSE (ie 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)

Deprecated. Superceeded by java-gnome 4.0; a method along these lines may well exist in the new bindings, but if it does it likely has a different name or signature due to the shift to an algorithmic mapping of the underlying native libraries.

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.

setText

public void setText(String text)

Deprecated. Superceeded by java-gnome 4.0; a method along these lines may well exist in the new bindings, but if it does it likely has a different name or signature due to the shift to an algorithmic mapping of the underlying native libraries.

Sets the text in the widget to the given value, replacing the current contents.
Parameters:
text - The new text.

setVisible

public void setVisible(boolean visible)

Deprecated. Superceeded by java-gnome 4.0; a method along these lines may well exist in the new bindings, but if it does it likely has a different name or signature due to the shift to an algorithmic mapping of the underlying native libraries.

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().


setWidth

public void setWidth(int number)

Deprecated. Superceeded by java-gnome 4.0; a method along these lines may well exist in the new bindings, but if it does it likely has a different name or signature due to the shift to an algorithmic mapping of the underlying native libraries.

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

textIndexToLayoutIndex

public int textIndexToLayoutIndex(int textIndex)

Deprecated. Superceeded by java-gnome 4.0; a method along these lines may well exist in the new bindings, but if it does it likely has a different name or signature due to the shift to an algorithmic mapping of the underlying native libraries.

Converts from a position in the entry's PangoLayout (returned by getLayout()) to a position in the entry contents (returned by getText()).