Namespace eclipse.sites.util

Holds stateless utility methods for dealing with sites.
Defined in: </shared/eclipse/e4/orion/I201106101640/plugins/org.eclipse.orion.client.core/web/orion/siteUtils.js>.

Namespace Summary
Constructor Attributes	Constructor Name and Description
	eclipse.sites.util

Method Summary
Method Attributes	Method Name and Description
<static>	eclipse.sites.util.createSiteCommands(commandService, siteService, statusService, dialogService, startCallback, stopCallback, deleteCallback, errorCallback) Creates & adds commands that act on an individual site configuration.
<static>	eclipse.sites.util.generateEditSiteHref(site) Returns a relative URL pointing to the editing page for the given site configuration.
<static>	eclipse.sites.util.makeFullFilePath(target)
<static>	eclipse.sites.util.makeRelativeFilePath(projectLocation)
<static>	eclipse.sites.util.parseStateFromHash(hash) Parses the state of the site page from a hash value.
<static>	eclipse.sites.util.stateToHash(siteLocation, String, String) Converts the state of the site page into a hash string.

Namespace Detail

eclipse.sites.util

Method Detail

<static> eclipse.sites.util.createSiteCommands(commandService, siteService, statusService, dialogService, startCallback, stopCallback, deleteCallback, errorCallback)

Creates & adds commands that act on an individual site configuration.

Parameters:
{eclipse.CommandService} commandService
{eclipse.sites.SiteService} siteService
{eclipse.StatusReportingService} statusService
{eclipse.DialogService} dialogService
{Function} startCallback
{Function} stopCallback
{Function} deleteCallback
{Function} errorCallback: Called when a server request fails.

<static> {String} eclipse.sites.util.generateEditSiteHref(site)

Returns a relative URL pointing to the editing page for the given site configuration.

Parameters:
{eclipse.sites.SiteConfiguration} site

Returns:: {String} The URL.

<static> {String} eclipse.sites.util.makeFullFilePath(target)

Parameters:
target: The "Target" field from a site configuration

Returns:: {String} The URL that the target points to.
FIXME: this is URL manipulation; it should be done by the server

Requires:: eclipse.util

<static> {String} eclipse.sites.util.makeRelativeFilePath(projectLocation)

Parameters:
projectLocation: The absolute URL of a file resource.

Returns:: {String} The path of the URL, relative to this server, with no /file/ prefix.
FIXME: this is URL manipulation; it should be done by the server

Requires:: eclipse.util

<static> {Object} eclipse.sites.util.parseStateFromHash(hash)

Parses the state of the site page from a hash value.

Parameters:
{String} hash: The hash string.

Returns:

{Object} An object having the properties:

String site The location URL of the site being edited.
String action Optional, currently unused
String actionDetails Optional, currently unused

<static> {String} eclipse.sites.util.stateToHash(siteLocation, String, String)

Converts the state of the site page into a hash string.

Parameters:
{String} siteLocation: The location URL of the site configuration being edited.
String Optional: action Currently unused
String Optional: actionDetails Currently unused

Returns:: {String} Hash string representing the new state.

Classes

Namespace eclipse.sites.util