com.ibm.hi.customizer.beans.scci
Interface SCTextfield

All Superinterfaces:
SCCustomComponent, SCTextComponent

public interface SCTextfield
extends SCTextComponent

SCTextfield is the interface for textfield components.


Method Summary
 void cut()
          Cuts any selected text from the textfield and copies it into the clipboard.
 char getEchoChar()
          Gets echo character.
 boolean isEditable()
          Indicates whether or not this text component is editable.
 boolean isPassword()
          Gets the password flag.
 void paste()
          Pastes clipboard text into the text component.
 void replaceSelection(java.lang.String newText)
          Replaces any selected text with the specified text.
 void setEchoChar(char character)
          Sets the echo character.
 void setEditable(boolean editable)
          Sets the flag that determines whether or not this textfield is editable.
 void setPassword(boolean password)
          Sets the password flag.
 
Methods inherited from interface com.ibm.hi.customizer.beans.scci.SCTextComponent
clearSelection, copy, getCaretPosition, getColumns, getSelectedText, getSelectionEnd, getSelectionStart, getText, getText, select, selectAll, setCaretPosition, setSelectionEnd, setSelectionStart, setText, setText
 
Methods inherited from interface com.ibm.hi.customizer.beans.scci.SCCustomComponent
getBackgroundColor, getCaption, getForegroundColor, getGlobalRead, getGlobalWrite, getHelpCaption, getHostLinkLength, getHostLinkPosition, getTabNumber, hasFocus, isTempHidden, isVisible, readGlobalVariable, requestFocus, setBackgroundColor, setCaption, setForegroundColor, setGlobalRead, setGlobalWrite, setHelpCaption, setTempHidden, setVisible, toString, writeGlobalVariable
 

Method Detail

setEchoChar

public void setEchoChar(char character)
Sets the echo character.

The echo character is only used if this textfield's password property is set to true. The default echo character is '*'

Parameters:
character - the echo character for this textfield.
See Also:
getEchoChar(), setPassword(boolean)

getEchoChar

public char getEchoChar()
Gets echo character.
Returns:
the echo character
See Also:
setEchoChar(char), setPassword(boolean)

setPassword

public void setPassword(boolean password)
Sets the password flag.

If the flag is set to true, this textfield will become a password field, echoing an echo character, rather than the actual text; if the flag is set to false, this textfield will disregard the echo character and display the actual text.

Parameters:
password - a flag indicating whether this textfield should be a password field or not
See Also:
setEchoChar(char), isPassword()

isPassword

public boolean isPassword()
Gets the password flag.
Returns:
true if this text component is a password field; false otherwise.
See Also:
setPassword(boolean)

setEditable

public void setEditable(boolean editable)
Sets the flag that determines whether or not this textfield is editable.

If the flag is set to true, this textfield becomes user editable. If the flag is set to false, the user cannot change the text of this textfield.

Parameters:
editable - a flag indicating whether this textfield should be user editable.
See Also:
isEditable()

isEditable

public boolean isEditable()
Indicates whether or not this text component is editable.
Returns:
true if this text component is editable; false otherwise.
See Also:
setEditable(boolean)

cut

public void cut()
Cuts any selected text from the textfield and copies it into the clipboard.
See Also:
SCTextComponent.copy()

replaceSelection

public void replaceSelection(java.lang.String newText)
Replaces any selected text with the specified text.
Parameters:
newText - the new text to replace the selected text
See Also:
SCTextComponent.select(int, int)

paste

public void paste()
Pastes clipboard text into the text component.
See Also:
SCTextComponent.copy()