|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
This class allows an editor to display and update an SOA model.
A typical calling sequence is as follows:
ISOAPropertiesContribution.createControls()
ISOAPropertiesContribution.setInput()
ISOAPropertiesContribution.aboutToBeShown()
ISOAPropertiesContribution.refresh()
ISOAPropertiesContribution.aboutToBeHidden()
ISOAPropertiesContribution.dispose()
Inbetween the calls to:
the following may be called:
ISOAPropertiesContribution.refresh()
Requires the controls to be updated with the current input
ISOAPropertiesContribution.requiresNewControls()
Controls may be reused to display objects of compatible types.
Calls to this method can be used to determine if the current set of controls
are sufficient to display the new object of compatible types. If this method
returns false
, then the following sequence of calls are made:
ISOAPropertiesContribution.setInput()
ISOAPropertiesContribution.aboutToBeShown()
ISOAPropertiesContribution.refresh()
If this method returns true
, then the following sequence of calls
are made:
Method Summary | |
void |
aboutToBeHidden()
Notifies the contributor that its controls are about to be hidden. |
void |
aboutToBeShown()
Notifies the contributor that its controls are about to be shown. |
void |
createControls(org.eclipse.swt.widgets.Composite composite,
java.lang.Object object)
Creates the controls for the PropertyPage. |
java.lang.Object |
createInstance(java.lang.Object container,
java.lang.String targetTypeNamespace,
java.lang.String targetType)
Create and initialize an instance of the type. |
void |
dispose()
Dispose this property page. |
org.eclipse.swt.graphics.Image |
getIcon()
Returns the icon for the type of the contribution. |
java.lang.String |
getLongDescription(java.lang.Object object)
Returns a long description of the object |
java.lang.String |
getShortDescription(java.lang.Object object)
Returns a short description of the object. |
ITabDescriptor[] |
getTabDescriptors()
Return the descriptors for the tabs required by the contribution. |
java.lang.String |
getTypeName()
Returns the name for the type. |
void |
refresh()
Refresh the contents of the controls displayed in the property pages. |
boolean |
requiresNewControls(java.lang.Object newObject)
Returns whether a new set of controls needs to be created to display this new object. |
void |
setInput(java.lang.Object object,
IEditorHandler editorHandler)
Identifies the selected object whose properties are about to be shown. |
Method Detail |
public void createControls(org.eclipse.swt.widgets.Composite composite, java.lang.Object object)
composite
- the composite for the property page.object
- object to create controls for. The controls should not be populated with data until
a future call to refresh()
is made.public boolean requiresNewControls(java.lang.Object newObject)
newObject
- the object about to be displayed in the controls
true
if the current set of controls is not sufficient to
display this new object and a new set of controls needs to be built. Returns false
if the current set of controls can be reused to display the new object.public void setInput(java.lang.Object object, IEditorHandler editorHandler)
object
- the selected model objecteditorHandler
- object used to report errors to the user and to handle updates to the modelpublic void aboutToBeShown()
Since the controls are not visible, the contributor should wait for the
refresh()
before updating the property page controls.
public void aboutToBeHidden()
public void dispose()
public void refresh()
public java.lang.Object createInstance(java.lang.Object container, java.lang.String targetTypeNamespace, java.lang.String targetType)
container
- - object in the SOA model to which the new instance is to be addedtargetTypeNamespace
- - the namespace of the type of object to createtargetType
- - type of object to create
targetType
public org.eclipse.swt.graphics.Image getIcon()
public java.lang.String getShortDescription(java.lang.Object object)
object
- the object whose short description is to be returned
public java.lang.String getLongDescription(java.lang.Object object)
object
- the object whose short description is to be returned
public java.lang.String getTypeName()
public ITabDescriptor[] getTabDescriptors()
|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |