ErgoTechWiki

This page is read only. You can view the source, but not change it. Ask your administrator if you think this is wrong.
===== PasswordField =====

com.ergotech.vib.graphics.swing.SwingPasswordField

==== Image Examples ====

| {{:mistudio:graphics:more_layout:text_display_lists:pasted:20260627-101510.png?40|PasswordField in the graphics palette}} | {{:mistudio:graphics:more_layout:text_display_lists:pasted:20260627-101605.png?120|PasswordField graphic example}} |
| //PasswordField in the graphics palette.// | //PasswordField graphic example.// |

==== Overview ====

The PasswordField graphic is a More Layout text input graphic used to enter hidden or masked text.

PasswordField is useful when an application needs a text entry field where the typed characters should not be shown directly on the screen.

PasswordField sends the entered text through its output.

==== Common Uses ====

  * Entering hidden or masked text
  * Creating password-style input fields
  * Collecting short protected text values
  * Sending entered text into application logic
  * Creating login-style or authorization-style input areas

==== Input Behavior ====

PasswordField can be updated from an input connection.

The **updateDisplayedValue** port updates the displayed value from logic, a data source, or another component.

==== Output Behavior ====

PasswordField sends the entered text through **PrimaryOutPort**.

The output value is the string entered in the field.

==== PasswordField-Specific Behavior ====

PasswordField is designed for hidden text entry.

PasswordField-specific settings include:

  * **Name** Sets the name of the PasswordField graphic.
  * **Cursor Color** Sets the cursor color.
  * **Enabled** Controls whether the user can interact with the PasswordField.
  * **Font** Controls the font used in the field.
  * **Text Color** Sets the text color.
  * **HelpText** Sets helper or placeholder-style text.
  * **Selected Text Color** Sets the color used for selected text.
  * **Selection Color** Sets the background color used for selected text.
  * **Background Color** Sets the background color.
  * **Ignore Focus Lost** Controls whether focus-loss behavior is ignored.
  * **Visible** Controls whether the PasswordField is shown.

==== Logic Ports ====

In the Logic Editor, PasswordField includes these default ports:

  * **PrimaryOutPort**
  * **updateDisplayedValue**
  * **clearDataConnection**

The **PrimaryOutPort** sends the entered text value.

The **updateDisplayedValue** port updates the displayed PasswordField value from another source.

The **clearDataConnection** port clears the data connection.

==== Notes ====

Use PasswordField when users need to enter hidden or masked text.

PasswordField masks the entered text visually, but the value should still be handled securely by the application logic and any connected systems.

For editable multi-line text, use [[mistudio:design_editor:more_layout:text_display_lists:editabletextarea|EditableTextArea]].

For static text display, use [[mistudio:design_editor:more_layout:text_display_lists:label|Label]].

For general graphic behavior, see [[mistudio:design_editor:active_graphic|Active Graphic]].

==== Related Pages ====

  * [[mistudio:design_editor:start|MIStudio Design Editor]]
  * [[mistudio:design_editor:more_layout:start|More Layout]]
  * [[mistudio:design_editor:more_layout:text_display_lists:start|Text, Display, Lists, and Tables]]
  * [[mistudio:design_editor:more_layout:text_display_lists:editabletextarea|EditableTextArea]]
  * [[mistudio:design_editor:more_layout:text_display_lists:label|Label]]
  * [[mistudio:design_editor:active_graphic|Active Graphic]]