org.gnu.gtk

Class Entry

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()
Creates a new Entry widget.
Entry(Handle handle)
Method Summary
voidaddListener(EntryListener listener)
Register an object to handle spin events.
voidcopyClipboard()
voidcutClipboard()
voiddeleteSelection()
voiddeleteText(int start, int end)
floatgetAlignment()
Gets the value set by {@link #setAlignment}.
StringgetCharacters(int start, int end)
EntryCompletiongetCompletion()
intgetCursorPosition()
booleangetEditable()
static EntrygetEntry(Handle handle)
Internal static factory method to be used by Java-Gnome only.
ClassgetEventListenerClass(String signal)
EventTypegetEventType(String signal)
booleangetHasFrame()
Gets the value set by {@link #setHasFrame(boolean)}.
LayoutgetLayout()
Gets the Layout used to display the entry.
PointgetLayoutOffsets()
Obtains the position of the Layout used to render text in the entry, in widget coordinates.
intgetMaxLength()
Returns the maximum length of the contents of the widget.
StringgetText()
Retrieve the contents of the entry widget.
static TypegetType()
Retrieve the runtime type used by the GLib library.
booleangetVisible()
Retrieves whether the contents of the entry are visible or not.
intgetWidth()
Gets the value set by {@link #setWidth(int)}.
voidhandleToggleOverwrite()
intinsertText(String text, int offset)
intlayoutIndexToTextIndex(int layoutIndex)
Converts from a position in the entry contents (returned by {@link #getText}) to a position in the entry's {@link org.gnu.pango.Layout PangoLayout} (returned by {@link #getLayout}, with text retrieved via {@link org.gnu.pango.Layout#getText}).
voidpasteClipboard()
voidremoveListener(EntryListener listener)
Removes a listener
voidselectRegion(int start, int end)
Methods from Editable
voidsetActivateDefaultWidget(boolean setting)
If setting is TRUE, pressing Enter in the entry will activate the default widget for the window containing the entry.
voidsetAlignment(float xalign)
Sets the alignment for the contents of the entry.
voidsetCompletion(EntryCompletion completion)
voidsetCursorPosition(int position)
voidsetEditable(boolean isEditable)
voidsetHasFrame(boolean setting)
Sets whether the entry has a beveled frame around it.
voidsetInvisibleChar(char character)
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).
voidsetMaxLength(int max)
Sets the maximum allowed length of the contents of the widget.
voidsetText(String text)
Sets the text in the widget to the given value, replacing the current contents.
voidsetVisible(boolean visible)
Sets whether the contents of the entry are visible or not.
voidsetWidth(int number)
Changes the size request of the entry to be about the right size for number characters.
inttextIndexToLayoutIndex(int textIndex)
Converts from a position in the entry's {@link org.gnu.pango.Layout PangoLayout} (returned by {@link #getLayout}) to a position in the entry contents (returned by {@link #getText}).

Constructor Detail

Entry

public Entry()
Creates a new Entry widget.

Entry

public Entry(Handle handle)

Method Detail

addListener

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

See Also: EntryListener

copyClipboard

public void copyClipboard()

cutClipboard

public void cutClipboard()

deleteSelection

public void deleteSelection()

deleteText

public void deleteText(int start, int end)

getAlignment

public float getAlignment()
Gets the value set by {@link #setAlignment}.

getCharacters

public String getCharacters(int start, int end)

getCompletion

public EntryCompletion getCompletion()

getCursorPosition

public int getCursorPosition()

getEditable

public boolean getEditable()

getEntry

public static Entry getEntry(Handle handle)
Internal static factory method to be used by Java-Gnome only.

getEventListenerClass

public Class getEventListenerClass(String signal)

getEventType

public EventType getEventType(String signal)

getHasFrame

public boolean getHasFrame()
Gets the value set by {@link #setHasFrame(boolean)}.

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 {@link org.gnu.gdk.Point} identifying the x and y offset of the layout.

getMaxLength

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

getText

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

Returns: the text of the widget

getType

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

getVisible

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

getWidth

public int getWidth()
Gets the value set by {@link #setWidth(int)}.

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

handleToggleOverwrite

public void handleToggleOverwrite()

insertText

public int insertText(String text, int offset)

layoutIndexToTextIndex

public int layoutIndexToTextIndex(int layoutIndex)
Converts from a position in the entry contents (returned by {@link #getText}) to a position in the entry's {@link org.gnu.pango.Layout PangoLayout} (returned by {@link #getLayout}, with text retrieved via {@link org.gnu.pango.Layout#getText}).

pasteClipboard

public void pasteClipboard()

removeListener

public void removeListener(EntryListener listener)
Removes a listener

See Also: addListener

selectRegion

public void selectRegion(int start, int end)
Methods from Editable

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

setAlignment

public void setAlignment(float xalign)
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)

setEditable

public void setEditable(boolean isEditable)

setHasFrame

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

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 (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)
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)
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)
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)
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)
Converts from a position in the entry's {@link org.gnu.pango.Layout PangoLayout} (returned by {@link #getLayout}) to a position in the entry contents (returned by {@link #getText}).