|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectjava.awt.Component
java.awt.Container
java.awt.Panel
java.applet.Applet
javax.swing.JApplet
wt.clients.doc.WTDocumentAppletWithProgress
<param name="hosturl" value="http://www.somewhere.com/somedir/index.html">
<param name="type" value="FILE" or "URL">
<param name="target" value="e:\abcd\efgh\file.txt" or "www.url.com">
<param name="mode" value="UPLOAD" or "DOWNLOAD"> default is "UPLOAD"
<param name="defaultfile" value="*.*">
<param name="debug" value="TRUE" or "FALSE"> default is "FALSE"
<param name="bgcolor" value="########"> decimal integer value of the desired background color, default is 14934992
This is a decimal integer giving the red, green, and blue components
where the red component is in bits 16-23 of the argument,
the green component is in bits 8-15 of the argument,
and the blue component is in bits 0-7.
The value zero indicates no contribution from the primary color component.
Example: for the hex RGB color #E3E3CF, the bgcolor value would be "14934992". For #0000FF, bgcolor="255".
<param name="wt.context.locale" value="XX"> locale tag for current browser language
<param name="docClass" value="xxxDocument"> context class used for generating response URLs
<param name="workspacePath" value="drive\directory\filename"> user preference workspacePath value, if set
<param name="continueIfFileNotFound" value="true" or "false"> user preference - whether to automatically continue the operation if filepath is invalid
<param name="continueIfFileUnchanged" value="true" or "false"> user preference - whether to automatically continue the operation if local file is identical to Windchill file
<param name="uploadIfFileChanged" value="true" or "false"> user preference - whether to automatically upload if the local file is different than the Windchill file
Deprecation Notice: This class will be removed in the future.
Functionality previously handled by this applet has been redistributed
for improved performance, maintainability and customizability.
As of Windchill 7.0, this applet has been replaced by the following:
- business object operations such as create, update, checkin,
references/structure links and metadata persistence are now
being handled server-side by wt\doc\WTDocumentFormTaskDelegate
- content upload is now being handled by the business-object-neutral
wt.clients.util.http.UploadApplet
Supported API: false
Extendable: false
Nested Class Summary | |
(package private) class |
WTDocumentAppletWithProgress.DocumentHandle
Deprecated. |
static class |
WTDocumentAppletWithProgress.Server
Deprecated. |
Nested classes inherited from class javax.swing.JApplet |
JApplet.AccessibleJApplet |
Nested classes inherited from class java.applet.Applet |
Applet.AccessibleApplet |
Nested classes inherited from class java.awt.Panel |
Panel.AccessibleAWTPanel |
Nested classes inherited from class java.awt.Container |
Container.AccessibleAWTContainer |
Nested classes inherited from class java.awt.Component |
Component.AccessibleAWTComponent, Component.BltBufferStrategy, Component.FlipBufferStrategy |
Field Summary | |
private JButton |
cancel
Deprecated. |
protected static int |
CANCEL
Deprecated. |
private String |
CENTER_OFF
Deprecated. |
private String |
CENTER_ON
Deprecated. |
protected static String |
CHECKIN
Deprecated. |
private boolean |
complete
Deprecated. |
private static String |
CONTENT_RESOURCES
Deprecated. |
(package private) ResourceBundle |
contentResource
Deprecated. |
private ThreadGroup |
contextGroup
Deprecated. |
protected static String |
CONTINUE_IF_FILE_NOT_FOUND
Deprecated. |
protected static String |
CONTINUE_IF_FILE_UNCHANGED
Deprecated. |
protected boolean |
continueIfFileNotFound
Deprecated. |
protected boolean |
continueIfFileUnchanged
Deprecated. |
protected static String |
CREATE
Deprecated. |
private String |
DEBUG
Deprecated. |
protected static String |
DELIM
Deprecated. |
protected String |
delimiter
Deprecated. |
private Vector |
departments
Deprecated. |
private Vector |
descriptions
Deprecated. |
protected static int |
DO_UPLOAD
Deprecated. |
private Hashtable |
docAttributes
Deprecated. Hashtable used to hold the values passed in by the HTML form, so that the createDocument() method doesn't have to take an increasing number of hard-coded, specifically-ordered parameters but can pull the values out of docAttributes as needed. |
private String |
docClass
Deprecated. |
private String |
docOperation
Deprecated. |
private Vector |
docTypes
Deprecated. |
private WTDocumentAppletWithProgress.DocumentHandle |
documentHandle
Deprecated. DocumentHandle used to reference the document being
created. |
private static String |
DOCUMENTOID
Deprecated. |
static int |
DOWNLOAD
Deprecated. Download mode indicator. |
private boolean |
errorBeforeCheckedIn
Deprecated. |
private String |
errorMsg
Deprecated. |
private JLabel |
fileBytes
Deprecated. |
private JLabel |
files
Deprecated. |
private int |
filesCount
Deprecated. |
private static String |
HTTP_RESOURCES
Deprecated. |
(package private) HTTPUploadDownloadPanel |
hTTPUploadDownloadPanel1
Deprecated. |
private static Object |
initSync
Deprecated. |
private WTJSObject |
jsWin
Deprecated. |
private Vector |
lifeCycles
Deprecated. |
private String |
LINE_BREAK
Deprecated. |
private Vector |
names
Deprecated. |
protected static int |
NO_UPLOAD
Deprecated. |
private Vector |
numbers
Deprecated. |
private Vector |
oids
Deprecated. |
protected String |
persistedFilename
Deprecated. |
private Vector |
primaryFiles
Deprecated. |
private JProgressBar |
progressBarFile
Deprecated. |
private JProgressBar |
progressBarUpload
Deprecated. |
private boolean |
quit
Deprecated. |
private static ResourceBundle |
rb
Deprecated. |
private static String |
RB_NAME
Deprecated. |
private static String |
RESOURCES
Deprecated. Defined constant which specifies a String representation of
the fully-qualified class name of the ResourceBundle containing
localized text for the fields, labels and error-messages of this frame. |
private boolean |
skipUpload
Deprecated. |
static int |
TARGET_TYPE_FILE
Deprecated. Target type indicator for files. |
static int |
TARGET_TYPE_URL
Deprecated. Target type indicator for urls. |
private Vector |
teamTemplates
Deprecated. |
private Vector |
titles
Deprecated. |
protected static int |
UNKNOWN
Deprecated. |
protected static String |
UPDATE
Deprecated. |
static int |
UPLOAD
Deprecated. Upload mode indicator |
protected static String |
UPLOAD_IF_FILE_CHANGED
Deprecated. |
protected boolean |
uploadIfFileChanged
Deprecated. |
protected int |
uploadStatus
Deprecated. |
private URLFactory |
url_factory
Deprecated. |
protected static String |
WORKSPACE_PATH
Deprecated. |
protected String |
workspacePath
Deprecated. |
Fields inherited from class javax.swing.JApplet |
accessibleContext, rootPane, rootPaneCheckingEnabled |
Fields inherited from class java.applet.Applet |
|
Fields inherited from class java.awt.Panel |
|
Fields inherited from class java.awt.Container |
|
Fields inherited from class java.awt.Component |
BOTTOM_ALIGNMENT, CENTER_ALIGNMENT, LEFT_ALIGNMENT, RIGHT_ALIGNMENT, TOP_ALIGNMENT |
Fields inherited from interface java.awt.image.ImageObserver |
ABORT, ALLBITS, ERROR, FRAMEBITS, HEIGHT, PROPERTIES, SOMEBITS, WIDTH |
Constructor Summary | |
WTDocumentAppletWithProgress()
Deprecated. |
Method Summary | |
void |
actionPerformed(ActionEvent event)
Deprecated. |
void |
addHTTPUploadDownloadListener(HTTPUploadDownloadListener l)
Deprecated. Add listeners to upload and download events. |
String |
checkinDocument()
Deprecated. |
boolean |
checksumsMatch()
Deprecated. |
void |
clear()
Deprecated. |
private boolean |
confirm(String displayMessage)
Deprecated. |
String |
createDocument()
Deprecated. |
void |
destroy()
Deprecated. |
private WTContext |
getContext()
Deprecated. |
String |
getDefaultFilename()
Deprecated. Return the default file name. |
String |
getDocAttribute(String key)
Deprecated. |
String |
getDocAttributes()
Deprecated. |
WTDocument |
getDocument()
Deprecated. Returns the WTDocument created by this applet. |
private String |
getDocumentIdentity(FormatContentHolder document,
Locale locale)
Deprecated. |
private FormatContentHolder |
getFormatContentHolder(String doc_oid)
Deprecated. |
boolean |
getGlobalOverwriteWarning()
Deprecated. |
String |
getHostURL()
Deprecated. Return the host url. |
int |
getHTTPResponseCode()
Deprecated. |
String |
getMessageURL(String returnToAction,
String resourceBundle,
String textToken)
Deprecated. This method is for calling getMessageURL when there isn't an oid yet (i.e. |
String |
getMessageURL(String nextAction,
String resourceBundle,
String textToken,
String oid)
Deprecated. This method returns a URL that puts a message into the response header of the designated page, via the WTDocumentRedirectTaskDelegate. |
int |
getMode()
Deprecated. Return the file upload download model. |
int |
getOperationFailureCode()
Deprecated. |
int |
getOperationStatus()
Deprecated. Return the most recent status. |
String |
getOperationStatusMessage()
Deprecated. Return a user readable status message. |
private String |
getParameter(String paramName,
String defaultParamValue)
Deprecated. |
Applet |
getParentApplet()
Deprecated. |
Frame |
getParentFrame()
Deprecated. |
boolean |
getSkipUpload()
Deprecated. |
String |
getTarget()
Deprecated. Return the target path or url. |
int |
getTargetType()
Deprecated. Return the target type to file or url. |
void |
init()
Deprecated. |
private void |
initProgressDisplay()
Deprecated. |
boolean |
isEmbeddedApplet()
Deprecated. |
boolean |
isRemovable()
Deprecated. Return whether the primary content removal is permitted |
boolean |
isValidTarget()
Deprecated. |
boolean |
isValidTarget(String target)
Deprecated. |
void |
loadFormData()
Deprecated. |
private WTDocument |
newWTDocument()
Deprecated. |
void |
operationProgress(int thisFile,
int totalFiles,
int byteCount)
Deprecated. File transfer progress update if file quantity is available. |
void |
operationProgress(int thisFile,
int totalFiles,
long byteCount)
Deprecated. File transfer progress update if file quantity is available. |
void |
operationProgress(String contentName,
String path,
int byteCount)
Deprecated. File transfer progress update if filepath is available. |
void |
operationProgress(String contentName,
String path,
long byteCount)
Deprecated. File transfer progress update if filepath is available. |
void |
operationStatusChange(int newOperationStatus)
Deprecated. Notification of status change. Status codes are: Download.OPERATION_INACTIVE, Download.OPERATION_START, Download.OPERATION_CANCEL_REQUEST, Download.OPERATION_CANCEL, Download.OPERATION_COMPLETE, Download.OPERATION_FAILURE. |
void |
performOperation()
Deprecated. Perform the upload or download operation indicated by the mode property. |
void |
removeHTTPUploadDownloadListener(HTTPUploadDownloadListener l)
Deprecated. Remove upload/download listener. |
protected String |
saveContents()
Deprecated. |
void |
setChooseFileOrURLVisible(boolean visible)
Deprecated. |
void |
setDefaultFilename(String defaultName)
Deprecated. Set the default file name. |
void |
setDocAttribute(String key,
String value)
Deprecated. |
void |
setDocument(WTDocument newDocument)
Deprecated. Sets the WTDocument which is being handled by this applet. |
void |
setEmbeddedApplet(boolean newValue)
Deprecated. |
void |
setGetButtonVisible(boolean visible)
Deprecated. |
void |
setGlobalOverwriteWarning(boolean newValue)
Deprecated. |
boolean |
setHostURL(String urlString)
Deprecated. Set the host url. |
void |
setMode(int mode)
Deprecated. Set the file upload or download mode. |
void |
setRemovable(boolean removable)
Deprecated. Set whether primary content removal is permitted (whether remove button or checkbox is visible) |
void |
setSkipUpload(boolean newValue)
Deprecated. |
void |
setSkipUpload(String newValue)
Deprecated. |
void |
setTarget(String target)
Deprecated. Set the target path or url. |
void |
setTargetType(int targetType)
Deprecated. Set the target path or url. |
protected void |
setTargetType(String targetType)
Deprecated. Set the target path or url with a string argument. |
void |
start()
Deprecated. |
private void |
startProgressDisplay()
Deprecated. |
void |
stop()
Deprecated. |
String |
stripBoundaryDelim(String s,
String delim)
Deprecated. |
String |
updateDocument()
Deprecated. |
private FormatContentHolder |
updateDocument(String doc_oid,
DocumentFormData form_data)
Deprecated. |
protected String |
validateFormData()
Deprecated. |
private String |
validateTarget()
Deprecated. |
Methods inherited from class javax.swing.JApplet |
addImpl, createRootPane, getAccessibleContext, getContentPane, getGlassPane, getJMenuBar, getLayeredPane, getRootPane, isRootPaneCheckingEnabled, paramString, remove, setContentPane, setGlassPane, setJMenuBar, setLayeredPane, setLayout, setRootPane, setRootPaneCheckingEnabled, update |
Methods inherited from class java.applet.Applet |
getAppletContext, getAppletInfo, getAudioClip, getAudioClip, getCodeBase, getDocumentBase, getImage, getImage, getLocale, getParameter, getParameterInfo, isActive, newAudioClip, play, play, resize, resize, setStub, showStatus |
Methods inherited from class java.awt.Panel |
addNotify |
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Field Detail |
private static final String RB_NAME
private static final ResourceBundle rb
private Vector primaryFiles
private Vector numbers
private Vector names
private Vector titles
private Vector docTypes
private Vector departments
private Vector descriptions
private Vector lifeCycles
private Vector teamTemplates
private String errorMsg
private Vector oids
private JProgressBar progressBarFile
private JProgressBar progressBarUpload
private JLabel fileBytes
private JLabel files
private int filesCount
private JButton cancel
private boolean quit
private boolean complete
private static Object initSync
private ThreadGroup contextGroup
private static final String DOCUMENTOID
private String DEBUG
private WTJSObject jsWin
private URLFactory url_factory
private boolean errorBeforeCheckedIn
public static final int UPLOAD
public static final int DOWNLOAD
public static final int TARGET_TYPE_FILE
public static final int TARGET_TYPE_URL
private static String RESOURCES
String
representation of
the fully-qualified class name of the ResourceBundle
containing
localized text for the fields, labels and error-messages of this frame.
private static String CONTENT_RESOURCES
private static String HTTP_RESOURCES
ResourceBundle contentResource
protected static String CREATE
protected static String UPDATE
protected static String CHECKIN
protected static String CONTINUE_IF_FILE_NOT_FOUND
protected static String CONTINUE_IF_FILE_UNCHANGED
protected static String UPLOAD_IF_FILE_CHANGED
protected static String WORKSPACE_PATH
protected static String DELIM
protected boolean continueIfFileNotFound
protected boolean continueIfFileUnchanged
protected boolean uploadIfFileChanged
protected String workspacePath
protected String persistedFilename
protected String delimiter
protected static final int UNKNOWN
protected static final int NO_UPLOAD
protected static final int DO_UPLOAD
protected static final int CANCEL
protected int uploadStatus
private String LINE_BREAK
private String CENTER_ON
private String CENTER_OFF
HTTPUploadDownloadPanel hTTPUploadDownloadPanel1
private WTDocumentAppletWithProgress.DocumentHandle documentHandle
DocumentHandle
used to reference the document being
created. The DocumentHandle
is used as opposed to manipulating
the document directly, to keep changes to this document in sync with
changes to the document modified by the WTContentHolder
in
this frame. By using the DocumentHandle
, both this frame and
the contained WTContentHolder
panel will be manipulating the
same document reference.
private Hashtable docAttributes
private String docClass
private String docOperation
private boolean skipUpload
Constructor Detail |
public WTDocumentAppletWithProgress()
Method Detail |
public void init()
public void start()
public void stop()
public void destroy()
public Applet getParentApplet()
public Frame getParentFrame()
public void setSkipUpload(boolean newValue)
public void setSkipUpload(String newValue)
public boolean getSkipUpload()
public String getHostURL()
public boolean setHostURL(String urlString)
public int getTargetType()
public void setTargetType(int targetType)
targetType
- TARGET_TYPE_FILE or TARGET_TYPE_URL.protected void setTargetType(String targetType)
targetType
- TARGET_TYPE_FILE or TARGET_TYPE_URL.public String getTarget()
public void setTarget(String target)
target
- The target path, e.g. "E:\abcd\test.txt" or "E:\abcd\*.txt", or url.public int getMode()
public void setMode(int mode)
mode
- UploadDownload.DOWNLOAD or UploadDownload.UPLOAD.public boolean isRemovable()
public void setRemovable(boolean removable)
removable
- true if removable, false if notpublic String getDefaultFilename()
public void setDefaultFilename(String defaultName)
public boolean getGlobalOverwriteWarning()
public void setGlobalOverwriteWarning(boolean newValue)
public boolean checksumsMatch()
public boolean isValidTarget()
public boolean isValidTarget(String target)
public String stripBoundaryDelim(String s, String delim)
public String getMessageURL(String returnToAction, String resourceBundle, String textToken)
public String getMessageURL(String nextAction, String resourceBundle, String textToken, String oid)
nextAction
- is the "action" for the next pageresourceBundle
- is the path of the message's resource bundle (ex. wt.clients.doc.DocRB)textToken
- is the token needed to retrieve the message from the resource bundleoid
- is the oid of the documentpublic void setEmbeddedApplet(boolean newValue)
public boolean isEmbeddedApplet()
public void performOperation()
public int getOperationStatus()
public String getOperationStatusMessage()
public int getOperationFailureCode()
public int getHTTPResponseCode()
public void clear()
public void addHTTPUploadDownloadListener(HTTPUploadDownloadListener l)
UploadDownloadEvent
public void removeHTTPUploadDownloadListener(HTTPUploadDownloadListener l)
private String getParameter(String paramName, String defaultParamValue)
public String createDocument()
public String updateDocument()
public WTDocument getDocument()
WTDocument
created by this applet.
WTDocument
public void setDocument(WTDocument newDocument)
newDocument
- the WTDocument for the appletprotected String saveContents()
public void loadFormData()
public void setDocAttribute(String key, String value)
public String getDocAttribute(String key)
public String getDocAttributes()
private WTContext getContext()
public void setChooseFileOrURLVisible(boolean visible)
public void setGetButtonVisible(boolean visible)
public String checkinDocument()
private String validateTarget()
private boolean confirm(String displayMessage)
private String getDocumentIdentity(FormatContentHolder document, Locale locale)
protected String validateFormData()
private WTDocument newWTDocument() throws WTException
WTException
private FormatContentHolder getFormatContentHolder(String doc_oid) throws WTException
WTException
private FormatContentHolder updateDocument(String doc_oid, DocumentFormData form_data) throws WTException
WTException
public void operationProgress(String contentName, String path, int byteCount)
MultiPartPostListener
operationProgress
in interface MultiPartPostListener
public void operationProgress(String contentName, String path, long byteCount)
MultiPartPostListener
operationProgress
in interface MultiPartPostListener
public void operationProgress(int thisFile, int totalFiles, int byteCount)
MultiPartPostListener
operationProgress
in interface MultiPartPostListener
public void operationProgress(int thisFile, int totalFiles, long byteCount)
MultiPartPostListener
operationProgress
in interface MultiPartPostListener
public void operationStatusChange(int newOperationStatus)
MultiPartPostListener
operationStatusChange
in interface MultiPartPostListener
public void actionPerformed(ActionEvent event)
actionPerformed
in interface ActionListener
private void initProgressDisplay()
private void startProgressDisplay()
|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |