Home > Class Reference > %SYS namespace > %ZHSLIB.PackageManager.Developer.Extension.PackageManager.UI.fileSelect

%ZHSLIB.PackageManager.Developer.Extension.PackageManager.UI.fileSelect

class %ZHSLIB.PackageManager.Developer.Extension.PackageManager.UI.fileSelect extends %ZEN.Component.page

This class contains common methods and properties used by the fileSelect dialog, and may be shared by other classes that use the dynaView but not extended to standard dialog.

ISC Developers: Please use caution when modifying logic in this class. Your change needs to be tested in Windows, Unix, and VMS for all cases.

Property Inventory (Including Private)

Method Inventory (Including Private)

Parameters

parameter CSPURL = "/isc/studio/templates/"_$classname()_".cls";
Lock down access to this class to the /isc/studio/templates/ web application.
parameter DOMAIN = HSPM;
Inherited description: Localization domain
parameter SECURITYRESOURCE = %Development:USE;
All CSP/Zen pages in the package manager require USE permissions on the %Development resource.
parameter VALIDATEXML = 0;
Inherited description: Validate user pages

Properties (Including Private)

property DefaultDirectory as %ZEN.Datatype.string;
Composed Default Directory path. After much checking, this is the final default directory that is used as default.
Property methods: DefaultDirectoryDisplayToLogical(), DefaultDirectoryGet(), DefaultDirectoryIsValid(), DefaultDirectoryLogicalToDisplay(), DefaultDirectoryLogicalToOdbc(), DefaultDirectoryNormalize(), DefaultDirectorySet()
property DirFile as %ZEN.Datatype.string (ZENURL = "Dir");
Original Directory path and/or filename passed in. If null is passed in, then manager directory will be used.
Property methods: DirFileDisplayToLogical(), DirFileGet(), DirFileIsValid(), DirFileLogicalToDisplay(), DirFileLogicalToOdbc(), DirFileNormalize(), DirFileSet()
property FileName as %ZEN.Datatype.string (ZENURL = "File");
Original File name passed in (optional)
Property methods: FileNameDisplayToLogical(), FileNameGet(), FileNameIsValid(), FileNameLogicalToDisplay(), FileNameLogicalToOdbc(), FileNameNormalize(), FileNameSet()
property isVMS as %Boolean [ InitialExpression = "0" ];
Property methods: isVMSDisplayToLogical(), isVMSGet(), isVMSIsValid(), isVMSLogicalToDisplay(), isVMSLogicalToXSD(), isVMSNormalize(), isVMSSet(), isVMSXSDToLogical()
property isWINDOWS as %Boolean [ InitialExpression = "0" ];
Property methods: isWINDOWSDisplayToLogical(), isWINDOWSGet(), isWINDOWSIsValid(), isWINDOWSLogicalToDisplay(), isWINDOWSLogicalToXSD(), isWINDOWSNormalize(), isWINDOWSSet(), isWINDOWSXSDToLogical()
property showdirectoryonly as %ZEN.Datatype.string (ZENURL = "showdirectoryonly");
Whether to show directory only or with files
Property methods: showdirectoryonlyDisplayToLogical(), showdirectoryonlyGet(), showdirectoryonlyIsValid(), showdirectoryonlyLogicalToDisplay(), showdirectoryonlyLogicalToOdbc(), showdirectoryonlyNormalize(), showdirectoryonlySet()

Methods (Including Private)

method %OnGetSubtitle() as %String [ Language = objectscript ]
Get the (localized) subtitle string for the dialog. This should be implemented in a subclass.
method %OnGetTitle() as %String [ Language = objectscript ]
Get the (localized) title string for the dialog. This should be implemented in a subclass.
method BuildDrive(Output drives As %String, drive As %String, Output lastexistingdir As %String) [ Language = objectscript ]
Get drive list
classmethod CheckFileExt(File, FileType) as %String [ Language = objectscript, ZenMethod ]
Check if file has extension. If not, add it.
classmethod CheckPath(Path As %String, File As %String, FileType As %String) as %String [ Language = objectscript, ZenMethod ]
****** The Following Methods are Called from UtilFile*.csp Also ******
If user enters a directory but without drive, we add the drive here. This overrides the "Look in" directory. For Windows and VMS only.
classmethod CheckRootDir(File As %String) as %String [ Language = objectscript, ZenMethod ]
Check if user entered filename ends with ":". If yes, then we should add "/" or [000000] to make valid drive.
For Windows: If user enters : without \ then we add it here.
For VMS: If user enters : without any [directory] then add [000000] here.
If we don't do this then directory would be invalid.
classmethod GetDirFile(LookinDir, File, FileType) as %String [ Language = objectscript, ZenMethod ]
Construct new new file name, if it does not have dir yet
method GetDirectory(Dir As %String) as %String [ Language = objectscript, ZenMethod ]
Check if user entered directory exists. Return a valid directory.
method GetFileType(pWildcard As %String, Output pValueList, Output pDisplayList, Output pDefault) as %String [ Language = objectscript, ZenMethod ]
classmethod GetSubDir(LookinDir, Dir) as %String [ Language = objectscript, ZenMethod ]
Construct new directory given the Look in directory and selected directory from the middle frame
method GetViewContents(ByRef pParms As %String, Output pContents As %String, ByRef pHeader As %String) as %Status [ Language = objectscript ]
Build file and directory list
classmethod IsTopLevel(currentDir, newDir) as %Boolean [ Language = objectscript, ZenMethod ]
This is mainly for Windows. e.g. If you are already on the D:\ drive then don't go up to C:\.
method RebuildLookin(Dir, wildcard) [ Language = objectscript, ZenMethod ]
Construct new directory given the Look in directory and selected directory from the middle frame
method UpdateFileName(pDir) [ Language = objectscript, ZenMethod ]
clientmethod getDialogValue() [ Language = javascript ]
clientmethod hasdelimiter(file) [ Language = javascript ]
clientmethod ondialogFinish(action) as %Boolean [ Language = javascript ]
This callback, if defined, is called when the user presses the OK or Apply action buttons. If this returns false, then the action is cancelled.
Check FileName value. If user entered a path, then return as is.
If user enters something but not including a path, then add selected path in front of it.
It is possible that user is entering a sub directory or file, therefore as a curtersey we add the path for them.
In addition, if user enters a filename without a file extension, then we add the filetype choice from the drop-down.
clientmethod ondialogStart() [ Language = javascript ]
This callback, if defined, is called when the dialog page is loaded.
clientmethod onkeydownHandler(evt) [ Language = javascript ]
Examine if user hit the Return key. If yes, start the search. This method handles all keydown events on the window. Works for both IE and NS.
clientmethod onresizeHandler() [ Language = javascript ]
This client event, if present, is fired when the page is resized.

Inherited Members

Inherited Properties (Including Private)

Inherited Methods (Including Private)

Subclasses

Feedback