TIBCO ActiveMatrix Mediation Implementation Type v3.3.1

com.tibco.amsb.core.task.ui.property
Class MediationTaskGeneralSection

java.lang.Object
  extended by org.eclipse.ui.views.properties.tabbed.AbstractPropertySection
      extended by com.tibco.xpd.ui.properties.AbstractXpdSection
          extended by com.tibco.amsb.core.task.ui.property.BasePropertySection
              extended by com.tibco.amsb.core.task.ui.property.MediationTaskGeneralSection
All Implemented Interfaces:
com.tibco.xpd.ui.properties.CommandProvider, com.tibco.xpd.ui.properties.ModelChangeListener, java.util.EventListener, org.eclipse.emf.edit.domain.IEditingDomainProvider, org.eclipse.emf.edit.provider.INotifyChangedListener, org.eclipse.swt.events.DisposeListener, org.eclipse.swt.internal.SWTEventListener, org.eclipse.ui.views.properties.tabbed.ISection
Direct Known Subclasses:
CustomMediationTaskGeneralSection

public class MediationTaskGeneralSection
extends BasePropertySection
implements com.tibco.xpd.ui.properties.ModelChangeListener

Mediation tasks can use this section to provide a common General tab for their property view by extending these methods and invoking this super class infrastructure.


Nested Class Summary
 
Nested classes/interfaces inherited from class com.tibco.xpd.ui.properties.AbstractXpdSection
com.tibco.xpd.ui.properties.AbstractXpdSection.ContainerType
 
Field Summary
protected  org.eclipse.swt.widgets.Label contributeLabel
           
protected  org.eclipse.swt.widgets.Button contributeOutputField
           
protected  org.eclipse.swt.widgets.Text descriptionText
           
protected  boolean ignoreModelChanges
          Flag set when the UI callback updates a field, allows the refresh mechanism to know when to ignore changes
protected  MediationTask mediationTask
           
protected  org.eclipse.swt.widgets.Text nameText
          Label for the name of the task
 
Fields inherited from class com.tibco.amsb.core.task.ui.property.BasePropertySection
adapter, editPart
 
Fields inherited from class com.tibco.xpd.ui.properties.AbstractXpdSection
LAYOUT_DATA_SHORT_WIDTH_HINT
 
Fields inherited from class org.eclipse.ui.views.properties.tabbed.AbstractPropertySection
STANDARD_LABEL_WIDTH
 
Constructor Summary
MediationTaskGeneralSection()
           
 
Method Summary
protected  org.eclipse.emf.common.command.CompoundCommand createBaseCommand(java.lang.Object obj)
          Create a compound command to update the standard attributes of mediation task.
protected  org.eclipse.ui.forms.widgets.ScrolledForm createBaseForm(org.eclipse.swt.widgets.Composite parent, com.tibco.xpd.ui.properties.XpdFormToolkit toolkit)
          Derived classes use this method to create the base form for this section.
protected  void createContributeCommand(org.eclipse.emf.common.command.CompoundCommand command, boolean value)
           
protected  void createContributeOutputField(org.eclipse.swt.widgets.Composite root, com.tibco.xpd.ui.properties.XpdFormToolkit toolkit)
          Helper method to create the contribute output label & field, so derived classes can call this method as needed to get the same effect as when the base class calls it.
protected  org.eclipse.swt.widgets.Control doCreateControls(org.eclipse.swt.widgets.Composite parent, com.tibco.xpd.ui.properties.XpdFormToolkit toolkit)
          Standard method to create the user interface controls for this section.
protected  org.eclipse.emf.common.command.Command doGetCommand(java.lang.Object obj)
          return an EMF command that will change the model object based on the control values
protected  void doRefresh()
          Update the control values on the property sheet with the current model values
protected  boolean gotInput()
          Called after setInput to see if any input was accepted by this instance.
 void ignoreModelEvents(boolean ignore)
          Someone is telling us to ignore changes, so do record what to do
protected  void initBindings()
          need to subclass to implement it,this method must to call the registerForValidation method
 boolean isIgnoreEvents()
          We override this method to check for our own flag as well as the desire of the base class.
protected  void manageControl(com.tibco.amsb.core.task.ui.property.widget.CustomField field)
           
 void notifyChanged(org.eclipse.emf.common.notify.Notification notification)
          The model changed, so let our adapter update all of the listeners
 void setInput(java.util.Collection<?> items)
          Given a list of selected objects, extract the model object out of the selection and save it for later, also save the editPart as it holds the EditingDomain
protected  boolean showContributeOutputField()
          Override this method and return true to allow a user to change the state of the contributed data flag using a Toggle button.
 
Methods inherited from class com.tibco.amsb.core.task.ui.property.BasePropertySection
bindValidation, bindValidation, dispose, doGetInputContainer, execute, getBindingManager, getControlId, getEditingDomain, getInput, listenForChanges, modelChanged, updateButtonSelection
 
Methods inherited from class com.tibco.xpd.ui.properties.AbstractXpdSection
canShowInWizard, createControls, createControls, disableControlsForReadOnlyInput, forceLayout, getCommand, getControlsContainer, getEditingDomain, getInputContainer, getMinimumHeight, getPropertySheetPage, getSectionContainerType, getSite, getTextWidth, getXpdSectionContainerProvider, isCreated, manageControl, manageControl, manageControl, manageControl, manageControl, manageControl, manageControl, manageControlUpdateOnDeactivate, refresh, refreshTabs, setCanFinish, setCreated, setEnabled, setEnabled, setIgnoreEvents, setInput, setMinimumHeight, setSameGridDataWidth, setShouldUseExtraSpace, setShowInWizard, setXpdSectionContainerProvider, shouldUseExtraSpace, showTab, updateCCombo, updateText, widgetDisposed
 
Methods inherited from class org.eclipse.ui.views.properties.tabbed.AbstractPropertySection
aboutToBeHidden, aboutToBeShown, getPart, getSelection, getWidgetFactory
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

nameText

protected org.eclipse.swt.widgets.Text nameText
Label for the name of the task


descriptionText

protected org.eclipse.swt.widgets.Text descriptionText

contributeLabel

protected org.eclipse.swt.widgets.Label contributeLabel

contributeOutputField

protected org.eclipse.swt.widgets.Button contributeOutputField

ignoreModelChanges

protected boolean ignoreModelChanges
Flag set when the UI callback updates a field, allows the refresh mechanism to know when to ignore changes


mediationTask

protected MediationTask mediationTask
Constructor Detail

MediationTaskGeneralSection

public MediationTaskGeneralSection()
Method Detail

doCreateControls

protected org.eclipse.swt.widgets.Control doCreateControls(org.eclipse.swt.widgets.Composite parent,
                                                           com.tibco.xpd.ui.properties.XpdFormToolkit toolkit)
Standard method to create the user interface controls for this section.

Specified by:
doCreateControls in class com.tibco.xpd.ui.properties.AbstractXpdSection

showContributeOutputField

protected boolean showContributeOutputField()
Override this method and return true to allow a user to change the state of the contributed data flag using a Toggle button.

Returns:
true to show the field, false to hide it (default is false)

ignoreModelEvents

public void ignoreModelEvents(boolean ignore)
Someone is telling us to ignore changes, so do record what to do

Specified by:
ignoreModelEvents in interface com.tibco.xpd.ui.properties.ModelChangeListener
Parameters:
ignore - true is to ignore, false is to allow UI updates

isIgnoreEvents

public boolean isIgnoreEvents()
We override this method to check for our own flag as well as the desire of the base class. If either are ignoring events then return true.

Overrides:
isIgnoreEvents in class com.tibco.xpd.ui.properties.AbstractXpdSection

gotInput

protected boolean gotInput()
Called after setInput to see if any input was accepted by this instance.

Overrides:
gotInput in class BasePropertySection

notifyChanged

public void notifyChanged(org.eclipse.emf.common.notify.Notification notification)
The model changed, so let our adapter update all of the listeners

Specified by:
notifyChanged in interface org.eclipse.emf.edit.provider.INotifyChangedListener

createBaseForm

protected org.eclipse.ui.forms.widgets.ScrolledForm createBaseForm(org.eclipse.swt.widgets.Composite parent,
                                                                   com.tibco.xpd.ui.properties.XpdFormToolkit toolkit)
Derived classes use this method to create the base form for this section. The base form includes all of the standard fields for a MediationTask.

Parameters:
parent -
toolkit -
Returns:

createContributeOutputField

protected void createContributeOutputField(org.eclipse.swt.widgets.Composite root,
                                           com.tibco.xpd.ui.properties.XpdFormToolkit toolkit)
Helper method to create the contribute output label & field, so derived classes can call this method as needed to get the same effect as when the base class calls it.

Parameters:
root -
toolkit -

createBaseCommand

protected org.eclipse.emf.common.command.CompoundCommand createBaseCommand(java.lang.Object obj)
Create a compound command to update the standard attributes of mediation task.

Parameters:
obj - - not used
Returns:

createContributeCommand

protected void createContributeCommand(org.eclipse.emf.common.command.CompoundCommand command,
                                       boolean value)

manageControl

protected void manageControl(com.tibco.amsb.core.task.ui.property.widget.CustomField field)

doGetCommand

protected org.eclipse.emf.common.command.Command doGetCommand(java.lang.Object obj)
return an EMF command that will change the model object based on the control values

Specified by:
doGetCommand in class com.tibco.xpd.ui.properties.AbstractXpdSection

doRefresh

protected void doRefresh()
Update the control values on the property sheet with the current model values

Specified by:
doRefresh in class com.tibco.xpd.ui.properties.AbstractXpdSection

setInput

public void setInput(java.util.Collection<?> items)
Given a list of selected objects, extract the model object out of the selection and save it for later, also save the editPart as it holds the EditingDomain

Overrides:
setInput in class BasePropertySection

initBindings

protected void initBindings()
Description copied from class: BasePropertySection
need to subclass to implement it,this method must to call the registerForValidation method

Overrides:
initBindings in class BasePropertySection

TIBCO ActiveMatrix Mediation Implementation Type v3.3.1

Copyright © 2010 TIBCO Software Inc. All Rights Reserved.