This class is kept to provide an interface to the <class>Studio.Extension.Base</class> class which provides the general Studio extension interface. More...

Inheritance diagram for Base:

[legend]

Collaboration diagram for Base:

[legend]

Public Member Functions
_.Library.Status	AddToSourceControl (_.Library.String InternalName, _.Library.String Description)
	Called to add this item to source control.

_.Library.Status	AfterUserAction (_.Library.Integer Type, _.Library.String Name, _.Library.String InternalName, _.Library.Integer Answer, _.Library.String Msg, _.Library.Boolean Reload)
	This is called after the <method>UserAction</method> and after any template is run or dialog is displayed. More...

_.Library.Status	CheckIn (_.Library.String InternalName, _.Library.String Description)
	Check this routine/class/csp file into source control.

_.Library.Status	CheckOut (_.Library.String InternalName, _.Library.String Description)
	Check this routine/class/csp file out of source control.

_.Library.Status	GetLatest (_.Library.String InternalName)
	Get the latest version of this file from source control.

_.Library.Status	OnMenuItem (_.Library.String MenuName, _.Library.String InternalName, _.Library.String SelectedText, _.Library.Boolean Enabled, _.Library.String DisplayName)
	This is called for every menu item returned to Studio to allow the menu to be enabled/disabled without. More...

_.Library.Status	OnPortalCreate (_.ZEN.proxyObject pUserData)
	Callback invoked when the portal-based Source Control hooks instantiate the source control class. More...

_.Library.Status	RemoveFromSourceControl (_.Library.String InternalName, _.Library.String Description)
	Called to delete this item from source control.

_.Library.Status	UndoCheckout (_.Library.String InternalName)
	Undo the checkout of this item.

_.Library.Status	UserAction (_.Library.Integer Type, _.Library.String Name, _.Library.String InternalName, _.Library.String SelectedText, _.Library.String Action, _.Library.String Target, _.Library.String Msg, _.Library.Boolean Reload)
	This is called when the user performs an action that may need to interact with. More...

Public Member Functions inherited from Base
_.Library.String	ExternalName (_.Library.String InternalName)
	Convert the internal name, e.g. More...

_.Library.Status	GetStatus (_.Library.String InternalName, _.Library.Boolean IsInSourceControl, _.Library.Boolean Editable, _.Library.Boolean IsCheckedOut, _.Library.String UserCheckedOut)
	Return information about this entity.

_.Library.Boolean	IsInSourceControl (_.Library.String InternalName)
	Returns true if this item is in source control and false otherwise.

_.Library.Boolean	IsReadOnly (_.Library.String InternalName)
	Return true if this item should be marked as read only. More...

_.Library.Integer	ItemIconState (_.Library.String InternalName)
	Used to allow Studio to display different icons in open dialog or project window etc. More...

_.Library.Status	Login (_.Library.String Name, _.Library.String Password)
	Perform any login step here.

_.Library.Status	Logout ()
	Perform any logout step here.

_.Library.Status	OnAfterClassCompile (_.Library.String List, _.Library.Integer Level, _.Library.String qstruct, _.Library.Status Status)
	Called in the class compiler after we have compiled all the classes before we exit. More...

_.Library.Status	OnAfterCompile (_.Library.String InternalName)
	Called after the compile of the item is done.

_.Library.Status	OnAfterDelete (_.Library.String InternalName)
	Called after an item is deleted.

_.Library.Status	OnAfterLoad (_.Library.String InternalName, _.Library.RegisteredObject Object)
	This is called after the item is loaded but before it is sent to Studio. More...

_.Library.Status	OnAfterSave (_.Library.String InternalName, _.Library.RegisteredObject Object)
	This is called after the item has been saved to the database. More...

_.Library.Status	OnAfterStorage (_.Library.String InternalName, _.Library.String Location)
	This is called if you compile a class and the compilation updates the class storage. More...

_.Library.Status	OnBeforeClassCompile (_.Library.String List, _.Library.Integer Level, _.Library.String qstruct)
	Called in the class compiler after we have resolved the list of classes to be compiled but. More...

_.Library.Status	OnBeforeCompile (_.Library.String InternalName, _.Library.String qstruct)
	Called before the compile of the item is done. More...

_.Library.Status	OnBeforeDelete (_.Library.String InternalName)
	Called before an item is deleted. More...

_.Library.Status	OnBeforeLoad (_.Library.String InternalName)
	This is called before the actual load of data to give the chance. More...

_.Library.Status	OnBeforeSave (_.Library.String InternalName, _.Library.String Location, _.Library.RegisteredObject Object)
	Called before the item is saved to the database it is passed. More...

	OnBeforeTimestamp (_.Library.String InternalName)
	Called before Studio checks for the timestamp of an item.

Public Member Functions inherited from RegisteredObject
_.Library.Status	OnAddToSaveSet (_.Library.Integer depth, _.Library.Integer insert, _.Library.Integer callcount)
	This callback method is invoked when the current object is added to the SaveSet,. More...

_.Library.Status	OnConstructClone (_.Library.RegisteredObject object, _.Library.Boolean deep, _.Library.String cloned)
	This callback method is invoked by the <METHOD>ConstructClone</METHOD> method to. More...

_.Library.Status	OnNew ()
	This callback method is invoked by the <METHOD>New</METHOD> method to. More...

_.Library.Status	OnValidateObject ()
	This callback method is invoked by the <METHOD>ValidateObject</METHOD> method to. More...

Static Public Member Functions
	GetPortalPageOptions (_.Library.String pPageURL, _.Library.String pOptions)
	API to give developers control over the HTML environment. More...

Static Public Member Functions inherited from Base
_.Library.String	IsGenerated (_.Library.String Name)
	Return 1 if you wish this item to appear as if it is 'generated' when opened in Studio,. More...

_.Library.Status	OnAfterAllClassCompile (_.Library.String List, _.Library.Integer Level, _.Library.String qstruct, _.Library.Status Status)
	Called in the activated source control class after we have compiled all the classes but before we exit. More...

_.Library.Status	OnBeforeAllClassCompile (_.Library.String List, _.Library.Integer Level, _.Library.String qstruct)
	Called in the activated source control class before starting a compile after we have resolved the list of classes. More...

Static Public Attributes
	Flags = None
	Used to control which dialogs appear in Studio. More...

Static Public Attributes inherited from RegisteredObject
	CAPTION = None
	Optional name used by the Form Wizard for a class when generating forms. More...

	JAVATYPE = None
	The Java type to be used when exported.

	PROPERTYVALIDATION = None
	This parameter controls the default validation behavior for the object. More...

Additional Inherited Members
Public Attributes inherited from Base
	IconStatus
	Can be set to determine if we wish to report the source control status of the document in the project window. More...

	MainJob
	$Job number of the main Studio process or blank if this is the main Studio connection. More...

	Modified
	If the root node is set to 1 then calls to the source control hooks will keep track if the. More...

	StudioVersion
	Version of Studio that is connecting to this server. More...

	Username
	The username of this source control user. More...

Detailed Description

This class is kept to provide an interface to the <class>Studio.Extension.Base</class> class which provides the general Studio extension interface.

Subclass from this and implement the methods you need for your source control system.

Member Function Documentation

◆ AfterUserAction()

_.Library.Status AfterUserAction	(	_.Library.Integer	Type,
		_.Library.String	Name,
		_.Library.String	InternalName,
		_.Library.Integer	Answer,
		_.Library.String	Msg,
		_.Library.Boolean	Reload
	)

This is called after the <method>UserAction</method> and after any template is run or dialog is displayed.

For a list of input arguments see <method>UserAction</method>. In the case of the dialog the button pushed by the user is passed in Answer:

0 - No
1 - Yes
2 - Cancel

For the dialog that contains a textbox field the text of this field is passed in 'Msg' argument. In the case of a template if the template was closed from the 'x' button then Answer=2 to indicate the user attempted to cancel the operation. Otherwise if the template closed normally by getting to the end Answer=1. For the cases where Studio did not perform any interaction this method is not called. The default implementation is to call the standard source control tags . If the Reload argument is set to true by this method then the current document will be reloaded in Studio.

Reimplemented from Base.

Reimplemented in ISC.

◆ GetPortalPageOptions()

GetPortalPageOptions	(	_.Library.String	pPageURL,
		_.Library.String	pOptions
	)

static

API to give developers control over the HTML environment.

Used when viewing a source control popup

for the URL in pPageURL from the portal. Developers can specify the following keys in pOptions:

IECompatibility - set pOptions("IECompatibility") to 1 to permit IE compatibility mode when rendering the URL. The default behaviour is to force IE to use its most recent rendering engine.
CSSLevel - set pOptions("CSSLevel") to 2 to force HTML 4 output, or 3 to force HTML 5 output. The default behaviour is to use HTML5 output when the browser can support it. Note that the values follow the semantics for the OnDetermineCSSLevel() callback implemented in <class>ZEN.Component.abstractPage</class>.

◆ OnMenuItem()

_.Library.Status OnMenuItem	(	_.Library.String	MenuName,
		_.Library.String	InternalName,
		_.Library.String	SelectedText,
		_.Library.Boolean	Enabled,
		_.Library.String	DisplayName
	)

This is called for every menu item returned to Studio to allow the menu to be enabled/disabled without.

having to write a custom query for <query>MenuItems</query>. The DisplayName of this menu is also passed by reference and this may be modified to change the appearance of this menu item. The MenuName is the main menu name then the submenu name separated by a ','. If Enabled is set to -1 then it will remove this menu item from the list totally, 0 will gray the menu item out, and the default 1 will display the menu item as normal.

Reimplemented from Base.

Reimplemented in ISC, and SourceControl.

◆ OnPortalCreate()

_.Library.Status OnPortalCreate ( _.ZEN.proxyObject pUserData )

Callback invoked when the portal-based Source Control hooks instantiate the source control class.

Operations that occur in this callback should be lightweight as the source control class needs to be instantiated afresh every time a source control action is performed.

Reimplemented in SourceControl.

◆ UserAction()

_.Library.Status UserAction	(	_.Library.Integer	Type,
		_.Library.String	Name,
		_.Library.String	InternalName,
		_.Library.String	SelectedText,
		_.Library.String	Action,
		_.Library.String	Target,
		_.Library.String	Msg,
		_.Library.Boolean	Reload
	)

This is called when the user performs an action that may need to interact with.

the server, such as selecting a menu or adding a new document. This encompases what the deprecated Flags parameter did and allows additional flexibility.

The Type argument values are:

0 : Server defined menu item selected
1 : Other Studio action

When a menu item is selected the Name argument is the name of this menu item in the format '<MainMenu>,<SubMenu>'. For other Studio actions the Name argument is one of:

0 : User has tried to change a document that is locked in source control
1 : User has created a new document
2 : User has deleted a document
3 : User has opened a document
4 : User has closed a document
5 : User has connected to a new namespace
6 : User has selected to import comma delimetered list of documents
7 : User has saved a new document for the first time

The InternalName argument is the name of the document about which this action occurs. If there is any selected text in the document which has focus this is sent in the SelectedText argument. The Action argument is set by this method to tell Studio what to do. Possible return values for this are:

0 : Do nothing, note that this method can still perform some action such as check an item out of source control, but Studio will not ask for user input.
1 : Display the default Studio dialog with a yes/no/cancel button. The text for this dialog is provided in the 'Target' return argument.
2 - Run a CSP page/Template. The Target is the full url to the CSP page/Template, as usual the page will be passed the current document name, any selected text, the project name, the namespace.
3 - Run an EXE on the client. The Target is the name of an executable file on the client machine. It is the responsibility of the customer to ensure this EXE is installed in a suitable location.
4 - Insert the text in Target in the current document at the current selection point.
5 - Studio will open the documents listed in Target. If there are multiple documents to open they will be separated with commas. If the document name is 'test.mac:label+10' it will open the document 'test.mac' and goto 'label+10'.
6 - Display an alert dialog in Studio with the text from the Target variable.
7 - Display a dialog with a textbox and Yes/No/Cancel buttons. The text for this dialog is provided by the 'Target' return argument. The initial text for the textbox is provided by the 'Msg' return argument.

If the Reload argument is set to true then the current document will be reloaded in Studio. This is useful if you change the document to change its attribute so Studio will pick up these changes.

Reimplemented from Base.

Reimplemented in ISC.

Member Data Documentation

◆ Flags

Flags = None

static

Used to control which dialogs appear in Studio.

If the position is '1'

then this dialog will appear and if it is '0' the <method>UserAction</method> will be called to determine what to do. This is included for backward compatibilty. The flags are:

1 : Present dialog on check in
2 : Present dialog on check out
3 : Ask to add new item to source control
4 : Ask to remove deleted item from source control

Public Member Functions

Static Public Member Functions

Static Public Attributes

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ AfterUserAction()

◆ GetPortalPageOptions()

◆ OnMenuItem()

◆ OnPortalCreate()

◆ UserAction()

Member Data Documentation

◆ Flags