Follow Techotopia on Twitter

On-line Guides
All Guides
eBook Store
iOS / Android
Linux for Beginners
Office Productivity
Linux Installation
Linux Security
Linux Utilities
Linux Virtualization
Linux Kernel
System/Network Admin
Programming
Scripting Languages
Development Tools
Web Development
GUI Toolkits/Desktop
Databases
Mail Systems
openSolaris
Eclipse Documentation
Techotopia.com
Virtuatopia.com

How To Guides
Virtualization
General System Admin
Linux Security
Linux Filesystems
Web Servers
Graphics & Desktop
PC Hardware
Windows
Problem Solutions
Privacy Policy

  




 

 


Eclipse Platform
Release 3.5

org.eclipse.ui.intro.config
Interface IIntroURL


public interface IIntroURL

An Intro url. An intro URL is a valid http url, with org.eclipse.ui.intro as a host name. It is intended to only be used in conjunction with the pre-supplied CustomizableIntroPart. See the org.eclipse.ui.intro.config extension point for more details.

An intro url instance is created by parsing the url and retrieving the embedded "command" and parametrs. For example, the following urls are valid intro urls:

  https://org.eclipse.ui.intro/close
  https://org.eclipse.ui.intro/runAction?pluginId=x.y.z&class=x.y.z.someClass
 

When parsed, the first url has "close" as a command, and no parameters. While the second "runAction" as a command and "pluginId" and "class" as parameters.

There is a number of supported Intro commands. Check docs for more details. Calling execute runs the command if it is one of the supported commands.

Since:
3.0
See Also:
IntroURLFactory, IIntroAction
Restriction:
This interface is not intended to be implemented by clients.
Restriction:
This interface is not intended to be extended by clients.

Method Summary
 boolean execute ()
          Executes whatever valid Intro command is embedded in this Intro URL.
  String getAction ()
           
  String getParameter ( String parameterId)
          Return a parameter defined in the Intro URL.
 

Method Detail

execute

boolean execute()
Executes whatever valid Intro command is embedded in this Intro URL. Returns true if action succeeded, and false otherwise.


getAction

String getAction()
Returns:
Returns the command imbedded in this URL.

getParameter

String getParameter(
String parameterId)
Return a parameter defined in the Intro URL. Returns null if the parameter is not defined.

Parameters:
parameterId - the id of the parameter being requested
Returns:
the value of the parameter, or null if the parameter is not defined

Eclipse Platform
Release 3.5

Guidelines for using Eclipse APIs.

Copyright (c) Eclipse contributors and others 2000, 2008. All rights reserved.


 
 
  Published under the terms of the Eclipse Public License Version 1.0 ("EPL") Design by Interspire