Package de.esoco.process.step

Klasse DialogFragment

java.lang.Object
org.obrel.core.RelatedObject
org.obrel.core.SerializableRelatedObject
de.esoco.process.ProcessElement
de.esoco.process.ProcessFragment
de.esoco.process.step.InteractionFragment
de.esoco.process.ViewFragment
de.esoco.process.step.DialogFragment
Alle implementierten Schnittstellen:
de.esoco.lib.manage.Initializable, Serializable, org.obrel.core.Relatable
Bekannte direkte Unterklassen:
MessageBoxFragment
public class DialogFragment extends ViewFragment
A process interaction fragment that can be displayed in a dialog view.
Siehe auch:

  • Felddetails

  • Konstruktordetails

    • DialogFragment

      public DialogFragment(String paramNameTemplate, InteractionFragment contentFragment, boolean modal, String question, Collection<DialogFragment.DialogAction> dialogActions)
      Creates a new instance for a certain content fragment. If the given fragment implements DialogFragment.DialogActionListener it will be registered as an action listener of this instance.
      Parameter:
      paramNameTemplate - The string format pattern for the generation of the view fragment parameter names. If NULL a template will be generated from the class name of the content fragment
      contentFragment - The fragment that contains the dialog content
      modal - viewStyle How the view should be displayed
      question - A string (typically a question) that will be displayed next to the dialog action buttons.
      dialogActions - The actions to be displayed as the dialog buttons

  • Methodendetails

    • disableButtonFillParameter

      public static void disableButtonFillParameter()
      Global configuration method to disable the addition of a fill parameter to the button panel.

      TODO This is just a workaround until the dialog fragment has been adapted to layout-bayed UI (instead of table-based).

    • addDialogActionListener

      public void addDialogActionListener(DialogFragment.DialogActionListener listener)
      Adds a listener for dialog actions that will be invoked after the fragment dialog has been closed.
      Parameter:
      listener - The listener to add

    • finishDialog

      public void finishDialog(DialogFragment.DialogAction action) throws Exception
      Finishes this dialog and hides it.
      Parameter:
      action - The action to finish the dialog with
      Löst aus:
      Exception - If finishing a sub-fragment fails

    • handleInteraction

      public void handleInteraction(org.obrel.core.RelationType<?> interactionParam) throws Exception
      Must be implemented by subclasses to handle interactions for this fragment. The default implementation does nothing.
      Setzt außer Kraft:
      handleInteraction in Klasse ViewFragment
      Parameter:
      interactionParam - The interaction parameter
      Löst aus:
      Exception - Any kind of exception may be thrown in case of errors

    • init

      public void init() throws Exception
      Must be implemented to initialize the interaction parameters of this fragment.
      Angegeben von:
      init in Schnittstelle de.esoco.lib.manage.Initializable
      Setzt außer Kraft:
      init in Klasse ViewFragment
      Löst aus:
      Exception - Any kind of exception may be thrown in case of errors

    • validateFragmentParameters

      public Map<org.obrel.core.RelationType<?>,String> validateFragmentParameters(boolean onInteraction)
      Overridden to only validate on interactions. The final validation of a dialog will be invoked by the finishDialog(DialogAction) method.
      Setzt außer Kraft:
      validateFragmentParameters in Klasse InteractionFragment
      Parameter:
      onInteraction - TRUE if the validation occurs during an ongoing interaction, FALSE after the final interaction before the fragment is finished
      Gibt zurück:
      A mapping from invalid parameters to validation error message (empty for none)
      Siehe auch:

    • addExtraViewInteractionParams

      protected void addExtraViewInteractionParams(String paramBaseName)
      This method can be overridden by subclasses to add additional interaction parameters to this instance. The default implementation does nothing.
      Setzt außer Kraft:
      addExtraViewInteractionParams in Klasse ViewFragment
      Parameter:
      paramBaseName - The base name for temporary parameters of this instance