Package com.apgar.common.lib.ui.widget.readonlywidget

Class ReadOnlyUICustomWidgetFactory

java.lang.Object

com.apgar.common.lib.ui.widget.readonlywidget.ReadOnlyUICustomWidgetFactory

All Implemented Interfaces:

UIWidgetFactory<ReadOnlyUICustomWidget>

public class ReadOnlyUICustomWidgetFactory
extends Object
implements UIWidgetFactory<ReadOnlyUICustomWidget>

Factory class for creating instances of ReadOnlyUICustomWidget.

This factory implements UIWidgetFactory and is responsible for instantiating and setting up ReadOnlyUICustomWidget, which enforces read-only rights on a field within a form.

This class is defined as follows under the field to be displayed as Read-Only in the XSD.

 <xs:element name="sampleField" minOccurs="0" maxOccurs="1">
     <xs:annotation>
         <xs:documentation xml:lang="en-US">
             <osd:label>Sample Field</osd:label>
         </xs:documentation>
         <xs:appinfo>
             <osd:defaultView>
                 <widget osd:class="com.apgar.common.lib.ui.widget.passwordwidget.ReadOnlyUICustomWidgetFactory"/>
             </osd:defaultView>
         </xs:appinfo>
     </xs:annotation>
 </xs:element>
 

Author:

APGAR Consulting

Constructor Summary

Constructors

Constructor	Description
ReadOnlyUICustomWidgetFactory()

Method Summary

Modifier and Type	Method	Description
ReadOnlyUICustomWidget	newInstance(WidgetFactoryContext context)	Creates a new instance of ReadOnlyUICustomWidget using the provided WidgetFactoryContext.
void	setup(WidgetFactorySetupContext context)	Sets up the ReadOnlyUICustomWidgetFactory during its initialization phase.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

ReadOnlyUICustomWidgetFactory

public ReadOnlyUICustomWidgetFactory()

Method Details

newInstance

public ReadOnlyUICustomWidget newInstance(WidgetFactoryContext context)

Creates a new instance of ReadOnlyUICustomWidget using the provided WidgetFactoryContext.

Specified by:

newInstance in interface UIWidgetFactory<ReadOnlyUICustomWidget>

Parameters:

context - the context providing information necessary for widget creation, including the path to the field that this widget will represent

Returns:

a new instance of ReadOnlyUICustomWidget associated with the specified path

setup

public void setup(WidgetFactorySetupContext context)

Sets up the ReadOnlyUICustomWidgetFactory during its initialization phase.

Specified by:

setup in interface UIWidgetFactory<ReadOnlyUICustomWidget>

Parameters:

context - the setup context providing additional information and services that may be used during the factory's setup