Examples of org.eclipse.ui.intro.config.IIntroContentProvider

org.eclipse.ui.intro.config.IIntroContentProvider
A content provider for dynamic intro content. It is initialized with the content provider site because a typical content provider would need to update its contents dynamically at runtime. And so, the site can be informed of a need to redraw its content through a call to its reflow(..) method.
The life cycle of an IIntroContentProvider is as follows:
- a content provider is defined in the Intro content markup file (ie: introContent.xml file) as follows:
  <contentProvider id="roles" class="x.y.z.ContentProvider">
  <text>Some alternate text for dynamic content</text>
  </contentProvider>
  This defines the content provider as part of the intro content for that page.
- the content provider class is created when the page that contains this provider is loaded. It is only created once in the life cycle of an open Intro view, ie: the class instance is cached and only disposed of when the intro view is closed.
- init() is called to initialize the instance of the class on load of the page. This is where the provider site can be cached for later reuse.
- createContent() is then called to give the content provider a chance to generate the dynamic content. This is when the dynamic content can be cached for later reuse when the same page is shown again.
- it is important to note that there is a difference between when the createContent() is called in the case of SWT and HTML presentations. The HTML presentation is dynamic html generated on the fly each time an Intro page needs to be displayed. SWT presentation on the other hand, is based on SWT forms widgets, and for performance, each page is only created once and cached in a pageBook for re-use. With this in mind, createContent() is called every time a page is shown in the case of HTML presentation. Whereas it is only called once in the case of the SWT presentation. This is why createContent() should not be used as a means of refreshing content. Content should only be created once during this method call, and cached for later re-use. If a refresh is needed, then reflow() should be called on the contentProviderSite when the appropriate event happens.
- finally, when the intro view is closed, dispose will be called on the content provider to give it a chance to dispose of any resources.

        layout.rightMargin = 0;
        container.setLayout(layout);
        container.setData(provider);




        IIntroContentProvider providerClass = ContentProviderManager.getInst()
            .getContentProvider(provider);
        if (providerClass == null)
            // content provider never created before, create it.
            providerClass = ContentProviderManager.getInst()
                .createContentProvider(provider, site);


        if (providerClass != null) {
            try {
                providerClass.createContent(provider.getId(), container,
                    toolkit);
            } catch (Exception e) {
                Log.error(
                    "Failed to create the content of Intro model content provider: " //$NON-NLS-1$
                            + provider.getClassName(), e);

View Full Code Here

    HTMLElement divElement = generateDivElement(element.getId(),
        IIntroHTMLConstants.DIV_CLASS_PROVIDED_CONTENT, indentLevel);


    // If we've already loaded the content provider for this element,
    // retrieve it, otherwise load the class
    IIntroContentProvider providerClass = ContentProviderManager.getInst().getContentProvider(element);
    if (providerClass == null)
      // content provider never created before, create it.
      providerClass = ContentProviderManager.getInst().createContentProvider(element, providerSite);


    if (providerClass != null) {
      StringWriter stringWriter = new StringWriter();
      PrintWriter pw = new PrintWriter(stringWriter);
      // create the specialized content
      providerClass.createContent(element.getId(), pw);
      // add the content of the specified file into the div element
      stringWriter.flush();
      divElement.addContent(stringWriter.toString());
      pw.close();
    } else {

View Full Code Here

    ContentProviderWrapper providerWrapper = (ContentProviderWrapper) contentProviders.get(provider
        .getId());
    if (providerWrapper == null)
      // return null if provider has not been created yet.
      return null;
    IIntroContentProvider providerClass = providerWrapper.getIIntroContentProvider();
    return providerClass;
  }

View Full Code Here

    // the content provider has never been created before. Create and cache
    // one.
    String pluginId = (provider.getPluginId() != null) ? provider.getPluginId() : provider.getBundle()
        .getSymbolicName();
    Object aClass = ModelLoaderUtil.createClassInstance(pluginId, provider.getClassName());
    IIntroContentProvider providerClass = null;
    if (aClass != null && aClass instanceof IIntroContentProvider) {
      providerClass = ((IIntroContentProvider) aClass);
      providerClass.init(site);
      if (provider.getId() != null) {
        // cache only when an id is defined.
        ContentProviderWrapper wrapper = new ContentProviderWrapper(providerClass, provider
            .getParentPage());
        contentProviders.put(provider.getId(), wrapper);

View Full Code Here

  }


  public void clear() {
    for (Iterator it = contentProviders.values().iterator(); it.hasNext();) {
      ContentProviderWrapper providerWrapper = (ContentProviderWrapper) it.next();
      IIntroContentProvider provider = providerWrapper.getIIntroContentProvider();
      provider.dispose();
    }
    contentProviders.clear();
    if (Log.logInfo)
      Log.info("Cleared Intro model content providers"); //$NON-NLS-1$
  }

View Full Code Here

TOP

Related Classes of org.eclipse.ui.intro.config.IIntroContentProvider

org.eclipse.ui.internal.intro.impl.html.IntroHTMLGenerator

org.eclipse.ui.internal.intro.impl.model.loader.ContentProviderManager

org.eclipse.ui.internal.intro.impl.swt.PageWidgetFactory

All source code are property of their respective owners. Java is a trademark of Sun Microsystems, Inc and owned by ORACLE Inc. Contact coftware#gmail.com.