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

Class FileAttachmentUICustomWidgetFactory

java.lang.Object

com.apgar.common.lib.ui.widget.fileattachmentwidget.FileAttachmentUICustomWidgetFactory

All Implemented Interfaces:

UIWidgetFactory<FileAttachmentUICustomWidget>

public class FileAttachmentUICustomWidgetFactory
extends Object
implements UIWidgetFactory<FileAttachmentUICustomWidget>

Factory class for creating instances of FileAttachmentUICustomWidget.

This factory implements UIWidgetFactory and is responsible for instantiating and setting up FileAttachmentUICustomWidget, which allows file attachment on a field within a form.

This class is defined as follows under the attachment field in the XSD.

 <xs:element name="attachmentField" minOccurs="0" maxOccurs="1">
     <xs:annotation>
         <xs:documentation xml:lang="en-US">
             <osd:label>Attachment Field</osd:label>
         </xs:documentation>
         <xs:appinfo>
             <osd:defaultView>
                 <widget osd:class="com.apgar.common.lib.ui.widget.fileattachmentwidget.FileAttachmentUICustomWidgetFactory">
                      <servletPath>/YourProject/FileUploadDownloadServlet</servletPath>
                      <fileUploadDirectory>/YourProject/FileUploadDownloadServlet</fileUploadDirectory>
                 </widget>
             </osd:defaultView>
         </xs:appinfo>
     </xs:annotation>
 </xs:element>
 

Author:

APGAR Consulting

Constructor Summary

Constructors

Constructor	Description
FileAttachmentUICustomWidgetFactory()

Method Summary

Modifier and Type	Method	Description
FileAttachmentUICustomWidget	newInstance(WidgetFactoryContext context)	Creates a new instance of FileAttachmentUICustomWidget using the provided WidgetFactoryContext.
void	setFileUploadDirectory(String fileUploadDirectory)	Sets the variable for the path of the file upload directory in your project
void	setServletPath(String servletPath)	Sets the variable for the path of the FileUploadDownloadServlet in your project
void	setup(WidgetFactorySetupContext context)	Sets up the FileAttachmentUICustomWidgetFactory during its initialization phase.

Methods inherited from class java.lang.Object

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

Constructor Details

FileAttachmentUICustomWidgetFactory

public FileAttachmentUICustomWidgetFactory()

Method Details

newInstance

public FileAttachmentUICustomWidget newInstance(WidgetFactoryContext context)

Creates a new instance of FileAttachmentUICustomWidget using the provided WidgetFactoryContext.

Specified by:

newInstance in interface UIWidgetFactory<FileAttachmentUICustomWidget>

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 FileAttachmentUICustomWidget associated with the specified path

setup

public void setup(WidgetFactorySetupContext context)

Sets up the FileAttachmentUICustomWidgetFactory during its initialization phase.

Specified by:

setup in interface UIWidgetFactory<FileAttachmentUICustomWidget>

Parameters:

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

setServletPath

public void setServletPath(String servletPath)

Sets the variable for the path of the FileUploadDownloadServlet in your project

Parameters:

servletPath - String

setFileUploadDirectory

public void setFileUploadDirectory(String fileUploadDirectory)

Sets the variable for the path of the file upload directory in your project

Parameters:

fileUploadDirectory - String