Examples of devplugin.ProgramReceiveTarget

• devplugin.ProgramReceiveTarget
  Is a target for receiving of program from other plugins.
  
  If your plugin should be able to receive programs from other plugins and handle those programs in a specific way you have to create ProgramReceiveTargets for the plugin.
  
  To do this use the constructor public ProgramReceiveTarget(ProgramReceiveIf receiveIf, String name, String targetId) . The receiveIf is you Plugin, the name is the name the user will be see for selection of the target and the targetId is a unique id which is used for identifying the target.
  
  If your plugin only supports one target simply don't override the method getProgramReceiveTargets().
  
  If you want to compare two targets always use the equals method.
  
  Example:
  Plugin name MyPlugin.
  
  MyPlugin is a plugin which want to receive programs for two types of targets. One target will be used to show the received programs in a dialog window, the other target will be used to mark the programs for the plugin.
  
  MyPlugin overrides the methods used for identifying it as a receiveable plugin:
  
  public boolean canReceiveProgramsWithTarget() {
  return true;
}

public boolean receivePrograms(Program[] programArr, ProgramReceiveTarget receiveTarget) {
  ProgramReceiveTarget[] targets = getSupportedTargets();

  if(targets[0].equals(receiveTarget)
    showProgramsInDialog(programArr);
  else if (targets[1].equals(receiveTarget)
    for(Program p : programArr)
      p.mark(this);
}

public ProgramReceiveTarget[] getProgramReceiveTargets() {
  return getSupportedTargets();
}
  
  The method getSupportedTargets() looks like this:
  
  private ProgramReceiveTarget[] getSupportedTargets() {
  ProgramReceiveTarget target1 = new ProgramReceiveTarget(this,"Show programs in dialog","showDialog");
  ProgramReceiveTarget target2 = new ProgramReceiveTarget(this,"Mark programs for MyPlugin","markPrograms");

  return new ProgramReceiveTarget[] {target1,target2};
}
  
  With this code the plugin MyPlugin is able to receive the programs from other plugins and handle it in the specified manner.
  
  @author René Mach @since 2.5

Related Classes of devplugin.ProgramReceiveTarget