Class EnsPortal.Component.classpathsTable

class EnsPortal.Component.classpathsTable extends %ZEN.Component.composite

A composite control containing the HTML to build out an 'add file' button and a table which displays each file in the ClassPath as a separate row

Inventory

Parameters	Properties	Methods	Queries	Indices	ForeignKeys	Triggers
2	6	21

Summary

Properties
%condition	%import	%includeFiles	%page
%resource	align	aux	cellAlign
cellSize	cellStyle	cellVAlign	children
childrenCreated	classpaths	composite	containerStyle
currFile	currFileName	disabled	dragEnabled
dropEnabled	enclosingClass	enclosingStyle	error
groupClass	groupStyle	height	hidden
hint	hintClass	hintStyle	id
inFileSelect	index	label	labelClass
labelDisabledClass	labelPosition	labelStyle	layout
name	onafterdrag	onbeforedrag	onclick
ondrag	ondrop	onhide	onrefresh
onshow	onupdate	parent	readOnly
showLabel	slice	title	tuple
valign	visible	width	wildcard
window

Methods
%AddChild	%AddChildAfter	%AddChildBefore	%AddToSaveSet
%Attr	%BindExport	%ClassIsLatestVersion	%ClassName
%ConstructClone	%CreateComposite	%DispatchClassMethod	%DispatchGetModified
%DispatchGetProperty	%DispatchMethod	%DispatchSetModified	%DispatchSetMultidimProperty
%DispatchSetProperty	%DrawComponentHTML	%DrawHTML	%DrawJSStrings
%EnclosingDivId	%Eval	%EvalC	%Extends
%ForceClientRender	%GetChildById	%GetChildIndex	%GetEventHandlers
%GetPaneContents	%GetParameter	%GetXMLName	%IsA
%IsModified	%MakeId	%New	%NormalizeObject
%ObjectModified	%OnAddToPageAfter	%OnAddToPageBefore	%OnAfterCreateComposite
%OnDrawEnclosingDiv	%OnDrawObjectProperties	%OnMutateChildren	%OnObjectSynch
%OnSubmit	%OnZENDeserialize	%OriginalNamespace	%PackageName
%QuoteValue	%QuoteValueL10N	%RemoveChild	%RemoveChildren
%RemoveFromSaveSet	%Self	%SerializeObject	%SetModified
%ValidateObject	CanViewFileSystem	GetContents	GetDefaultDir
GetFullFilepath	GetPathsToDisplay	SetDefaultDir	UseIRISHost
XMLDTD	XMLExport	XMLExportToStream	XMLExportToString
XMLNew	XMLSchema	XMLSchemaNamespace	XMLSchemaType
addChild	addChildAfter	addChildBefore	addFile
childrenMutated	createChildren	deleteFile	dragFinishHandler
dragHandler	dragNotifyHandler	dragStartHandler	dropHandler
dropStartHandler	exposeComponent	findElement	fireOnUpdateEvent
getChildById	getChildIndex	getEnclosingDiv	getForm
getHidden	getHintElement	getLabelElement	getProperty
getSettings	getType	getValue	invokeSuper
isOfType	makeId	onCreate	onDelete
onDisplayHandler	onEndModalHandler	onPopupAction	onRefreshContents
onSerialize	onStartModalHandler	ondisabledHandler	onloadHandler
onunloadHandler	onupdateHandler	refreshClasspaths	refreshContents
removeChild	render	renderContents	renderSVG
saveFile	setCurrFile	setHidden	setModified
setOverlayMode	setProperty	setPropertyAll	setValue
showFileSelect	startProgressBar	stopProgressBar	switchCurrFile

Parameters

• parameter DOMAIN = "Ensemble";

• parameter USECOMMONDIRECTORY = 1;

If true, then the include files generated for this component, are placed in the common /csp/broker directory and not the local /csp/*namespace* directory.
This is intended for use with packages that are mapped so as to be visible to every namespace.
All Zen classes within the same package must have the same value for this parameter. It is the developer's responsibility to ensure this.

Properties

• property classpaths as %String(MAXLEN="");

• property currFile as %Integer [ InitialExpression = 0 ];

• property currFileName as %String;

• property inFileSelect as %Boolean [ InitialExpression = 0 ];

• property readOnly as %ZEN.Datatype.boolean [ InitialExpression = 0 ];

• property wildcard as %ZEN.Datatype.string [ InitialExpression = "*" ];

Methods

• method CanViewFileSystem() as %Boolean [ ZenMethod ]

Is the user permitted to access the fileSelect popup.

• method GetContents() as %String [ ZenMethod ]

Get the contents of the CLASSPATH table

• classmethod GetDefaultDir() as %String [ ZenMethod ]

• classmethod GetFullFilepath(pFilename) as %String [ ZenMethod ]

• classmethod GetPathsToDisplay(pClasspaths="") as %String [ ZenMethod ]

• classmethod SetDefaultDir(pPathname As %String) [ ZenMethod ]

• classmethod UseIRISHost(pFilename) as %String [ ZenMethod ]

• method addFile() [ Language = javascript ]

• method createChildren(form) [ Language = javascript ]

Create children on client side so we can use them immediately. Note that the server may substitute fresh code-generated objects later.

• method deleteFile(pNumber) as %Boolean [ ZenMethod ]

• method getForm() [ Language = javascript ]

• method getProperty(property, key) as %String [ Language = javascript ]

Return the value of a named property (i.e. a setting).
Returns null if this is not a property of this object.
key is an optional argument used for properties (such as collections) that may need a key to find a specific value.

• final method getValue() [ Language = javascript ]

• method refreshClasspaths() [ Language = javascript ]

Refresh the table which displays the extra CLASSPATHS to use

• method saveFile(pNumber As %Integer, pValue As %String = "") as %Boolean [ ZenMethod ]

• method setCurrFile(switchTo) [ Language = javascript ]

Set a particular filepath to be editable

• method setModified() [ Language = javascript ]

Call on Production Config page's settingChanged() so that it recognizes this change

• method setProperty(property, value, value2) [ Language = javascript ]

Set the value of a named property.
Assume that subclasses that simply wrap HTML controls have named the control 'control' or else have overridden this method.

• final method setValue(value, value2) [ Language = javascript ]

Client-side method to set the value associated with this control. value2 is an optional, second parameter used by some controls (such as dataCombo).

• method showFileSelect(filename) [ Language = javascript ]

User clicked the Browse button. Helper method to wrap the main selectFile() function in the containing page.

• method switchCurrFile(switchTo, value) [ Language = javascript ]

If there is a filepath being edited, save that first before making another filepath editable Then set the new filepath to be editable

Class Reference IRIS for UNIX 2024.1.2
Documentation Search