org.eclipse.jpt.ui.details
Interface JpaPageComposite<T>

All Superinterfaces:
JpaComposite<T>

public interface JpaPageComposite<T>
extends JpaComposite<T>

A JpaPageComposite defines the common behavior of the JPA related widgets that is shown as a page within an editor.

Provisional API: This interface is part of an interim API that is still under development and expected to change significantly before reaching stability. It is available at this early stage to solicit feedback from pioneering adopters on the understanding that any code that uses this API will almost certainly be broken (repeatedly) as the API evolves.


Method Summary
 java.lang.String getHelpID()
          Returns the help ID.
 org.eclipse.swt.graphics.Image getPageImage()
          The image of the tab showing this page.
 java.lang.String getPageText()
          The text of the tab showing this page.
 
Methods inherited from interface org.eclipse.jpt.ui.details.JpaComposite
dispose, enableWidgets, getControl, populate
 

Method Detail

getHelpID

java.lang.String getHelpID()
Returns the help ID. This ID will be used if the help button is invoked.

Returns:
Either the help ID of this page or null if no help is required

getPageImage

org.eclipse.swt.graphics.Image getPageImage()
The image of the tab showing this page.

Returns:
The page's image

getPageText

java.lang.String getPageText()
The text of the tab showing this page.

Returns:
The page's text