Class ReadOnlyUICustomWidget

java.lang.Object
com.orchestranetworks.ui.form.widget.UICustomWidget
com.orchestranetworks.ui.form.widget.UISimpleCustomWidget
com.apgar.common.lib.ui.widget.readonlywidget.ReadOnlyUICustomWidget
All Implemented Interfaces:
com.orchestranetworks.ui.form.widget.UIWidget

public class ReadOnlyUICustomWidget extends com.orchestranetworks.ui.form.widget.UISimpleCustomWidget
A custom UI widget that enforces read-only rights on a field within a form.

This widget extends UISimpleCustomWidget and is designed to be used when a field needs to be displayed in a read-only state, preventing any user input.

Author:
APGAR Consulting
  • Constructor Summary

    Constructors
    Constructor
    Description
    ReadOnlyUICustomWidget(com.orchestranetworks.schema.Path path, com.orchestranetworks.ui.form.widget.WidgetFactoryContext context)
    Constructs a new ReadOnlyUICustomWidget for the specified path within the provided context.
  • Method Summary

    Modifier and Type
    Method
    Description
    void
    write(com.orchestranetworks.ui.form.widget.WidgetWriter writer, com.orchestranetworks.ui.form.widget.WidgetDisplayContext context)
    Renders the widget in the UI, setting the associated field to read-only.

    Methods inherited from class com.orchestranetworks.ui.form.widget.UISimpleCustomWidget

    validate

    Methods inherited from class com.orchestranetworks.ui.form.widget.UICustomWidget

    isDisplayingCustomWidgetValidationMessage, isEditorDisabled, setEditorDisabled, zza, zza, zzb

    Methods inherited from class java.lang.Object

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
  • Constructor Details

    • ReadOnlyUICustomWidget

      public ReadOnlyUICustomWidget(com.orchestranetworks.schema.Path path, com.orchestranetworks.ui.form.widget.WidgetFactoryContext context)
      Constructs a new ReadOnlyUICustomWidget for the specified path within the provided context.
      Parameters:
      path - the path to the field that this widget will represent
      context - the widget factory context providing additional information for widget creation
  • Method Details

    • write

      public void write(com.orchestranetworks.ui.form.widget.WidgetWriter writer, com.orchestranetworks.ui.form.widget.WidgetDisplayContext context)
      Renders the widget in the UI, setting the associated field to read-only.
      Specified by:
      write in class com.orchestranetworks.ui.form.widget.UISimpleCustomWidget
      Parameters:
      writer - the WidgetWriter used to output the widget in the UI
      context - the WidgetDisplayContext providing information about how the widget should be displayed