com.endeca.tools.pagebuilder.model.IEnvironmentInfo

Package	com.endeca.tools.pagebuilder.model
Interface	public interface IEnvironmentInfo

Provides information regarding the environment in which an editor has been created. This includes the currently available templates, Workbench state, and all editor configuration.

Public Properties

	Property		Defined by
		editorConfig : XML [read-only] The configuration which has been specified for this editor in the editor configuration file.	IEnvironmentInfo
		globalEditorConfig : XML [read-only] The configuration which has been specified for all editors in the editor configuration file.	IEnvironmentInfo
		templateConfig : XML [read-only] The configuration which has been specified for this editor in the template.	IEnvironmentInfo
		webstudioMDEXHostname : String [read-only] The hostname of the MDEX Engine that is used by Workbench and Page Builder.	IEnvironmentInfo
		webstudioMDEXPort : uint [read-only] The port of the MDEX Engine that is used by Workbench and Page Builder.	IEnvironmentInfo

Public Methods

	Method		Defined by
		getTemplateInfos(templateType:String, resultHandler:Function, errorHandler:Function):void Retrieves a collection of `IContentTemplateInfo` objects which may be used to construct content items.	IEnvironmentInfo

Property detail

editorConfig

property

editorConfig:XML [read-only]

The configuration which has been specified for this editor in the editor configuration file.

This property can be used as the source for data binding.

Implementation
public function get editorConfig():XML

globalEditorConfig

property

globalEditorConfig:XML [read-only]

The configuration which has been specified for all editors in the editor configuration file.

This property can be used as the source for data binding.

Implementation
public function get globalEditorConfig():XML

templateConfig

property

templateConfig:XML [read-only]

The configuration which has been specified for this editor in the template.

This property can be used as the source for data binding.

Implementation
public function get templateConfig():XML

webstudioMDEXHostname

property

webstudioMDEXHostname:String [read-only]

The hostname of the MDEX Engine that is used by Workbench and Page Builder.

This property can be used as the source for data binding.

Implementation
public function get webstudioMDEXHostname():String

webstudioMDEXPort

property

webstudioMDEXPort:uint [read-only]

The port of the MDEX Engine that is used by Workbench and Page Builder.

This property can be used as the source for data binding.

Implementation
public function get webstudioMDEXPort():uint

Method detail

getTemplateInfos

()

method

public function getTemplateInfos(templateType:String, resultHandler:Function, errorHandler:Function):void

Retrieves a collection of IContentTemplateInfo objects which may be used to construct content items.

The result handler function must match the following signature:

           function(templateList:IReadOnlyList):void

The error handler function must match the following signature:

           function(templateType:String, errorMessage:String):void

Parameters

	`templateType:String` — The type of templates to retrieve

	`resultHandler:Function` — A function which is called if the templates were successfully loaded. It is passed a list of the loaded `IContentTemplateInfo` objects.

	`errorHandler:Function` — A function which is called if the templates could not be loaded. It is passed the template type which was used in the attempt and an error message.

See also

com.endeca.tools.pagebuilder.model.content.IContentTemplateInfo
com.endeca.collections.IReadOnlyList