Package org.pentaho.di.ui.trans.step.common

Class CommonStepDialog<StepMetaType extends CommonStepMeta>

java.lang.Object
org.eclipse.swt.widgets.Dialog
org.pentaho.di.ui.trans.step.BaseStepDialog
org.pentaho.di.ui.trans.step.common.CommonStepDialog<StepMetaType>
Type Parameters:
StepMetaType -
All Implemented Interfaces:
org.pentaho.di.trans.step.StepDialogInterface
public abstract class CommonStepDialog<StepMetaType extends CommonStepMeta> extends BaseStepDialog implements org.pentaho.di.trans.step.StepDialogInterface
A common implementation of the BaseStepDialog that creates many of the common UI components.

  • Field Details

    • MARGIN_SIZE

      protected static final int MARGIN_SIZE
      See Also:

    • LABEL_SPACING

      protected static final int LABEL_SPACING
      See Also:

    • ELEMENT_SPACING

      protected static final int ELEMENT_SPACING
      See Also:

    • MEDIUM_FIELD

      protected static final int MEDIUM_FIELD
      See Also:

    • MEDIUM_SMALL_FIELD

      protected static final int MEDIUM_SMALL_FIELD
      See Also:

    • SMALL_FIELD

      protected static final int SMALL_FIELD
      See Also:

    • SHELL_WIDTH_OFFSET

      protected static final int SHELL_WIDTH_OFFSET
      See Also:

    • VAR_ICON_WIDTH

      protected static final int VAR_ICON_WIDTH

    • VAR_ICON_HEIGHT

      protected static final int VAR_ICON_HEIGHT

    • meta

      protected final StepMetaType extends CommonStepMeta meta

    • footerSpacer

      protected org.eclipse.swt.widgets.Label footerSpacer

    • headerSpacer

      protected org.eclipse.swt.widgets.Label headerSpacer

    • lsMod

      protected org.eclipse.swt.events.ModifyListener lsMod

    • m_wTabFolder

      protected org.eclipse.swt.custom.CTabFolder m_wTabFolder

  • Constructor Details

    • CommonStepDialog

      public CommonStepDialog(org.eclipse.swt.widgets.Shell parent, Object meta, org.pentaho.di.trans.TransMeta tr, String sname)

  • Method Details

    • initListenersImpl

      protected void initListenersImpl()
      Can be overridden to initialize additional listeners.

    • open

      public String open()
      Specified by:
      open in interface org.pentaho.di.trans.step.StepDialogInterface

    • buildPreHeader

      protected void buildPreHeader()
      Called at the top of buildHeader(), can be overridden to build additional "header" elements.

    • buildPostHeader

      protected void buildPostHeader()
      Called at the bottom of buildHeader(), can be overridden to build additional "header" elements.

    • buildBody

      protected abstract void buildBody()

    • buildPreFooter

      protected void buildPreFooter()
      Called at the top of buildFooter(), can be overridden to build additional "footer" elements.

    • buildPostFooter

      protected void buildPostFooter()
      Called at the bottom of buildFooter(), can be overridden to build additional "footer" elements.

    • buildPreviewButton

      protected org.eclipse.swt.widgets.Button buildPreviewButton()

    • buildGetFieldsButton

      protected org.eclipse.swt.widgets.Button buildGetFieldsButton(org.eclipse.swt.widgets.Composite parent, org.eclipse.swt.events.SelectionAdapter listener)

    • buildCancelButton

      protected org.eclipse.swt.widgets.Button buildCancelButton()

    • buildOkButton

      protected org.eclipse.swt.widgets.Button buildOkButton()

    • fieldsExist

      protected boolean fieldsExist()
      To be overridden by a preview-capable dialog, returns true by default.
      Returns:
      true by default

    • updatePreviewButtonStatus

      protected void updatePreviewButtonStatus()
      To be overridden by a preview-capable step dialog.

    • updateGetFieldsButtonStatus

      protected void updateGetFieldsButtonStatus()
      Can be overridden by the implementing class, if the "Get fields" button is to be enabled only under certain conditions.

    • ok

      protected void ok()

    • cancel

      protected void cancel()

    • getImage

      protected org.eclipse.swt.graphics.Image getImage()

    • getPopulatedMeta

      protected abstract StepMetaType getPopulatedMeta()
      Returns a new instance of CommonStepDialog that is populated according to dialog selection.
      Returns:
      a new instance of CommonStepDialog that is populated according to dialog selection

    • populateMeta

      protected abstract void populateMeta(StepMetaType meta)
      Creates a new instance of CommonStepDialog and populates it with provided data from the dialog.
      Parameters:
      meta - a new instance of CommonStepDialog

    • getTitle

      protected abstract String getTitle()

    • getData

      public abstract void getData(StepMetaType meta)
      Copy information from the CommonStepDialog meta to the dialog fields.

    • buildTabFolder

      protected org.eclipse.swt.custom.CTabFolder buildTabFolder()

    • layoutTabFolder

      protected void layoutTabFolder()

    • openDialog

      protected void openDialog(String title, String message, int dialogType)

    • openPreviewError

      protected void openPreviewError()

    • openNoRowsToPreviewError

      protected void openNoRowsToPreviewError()

    • openNoFieldsDialog

      protected void openNoFieldsDialog()

    • openFieldsErrorDialog

      protected void openFieldsErrorDialog()