Package com.ptc.cat.ui.client.action

Class LaunchURLAction

java.lang.Object
com.ptc.cat.ui.client.action.AbstractAction
com.ptc.cat.ui.client.action.JCAAction
com.ptc.cat.ui.client.action.LaunchURLAction
All Implemented Interfaces:
com.ptc.cat.ui.client.action.Action
public class LaunchURLAction extends com.ptc.cat.ui.client.action.JCAAction
An action that simply launches the URL specified in the action XML file. An oid parameter for the selected item will automatically be added the URL.

For example, the following action XML will launch the Manage Notes UI using this LaunchURLAction. The selected item's oid will be appended to the URL specified. 
 <action name="manageNotes" ajax="row" > 
  <command class="com.ptc.cat.ui.client.action.LaunchURLAction"
    method="execute" url="/app/#ptc1/tcomp/infoPage?tlnType=note&tlnAction=relatedNotes" 
    windowType="page"/>
  <includeFilter name="com.ptc.cat.ui.client.internal.action.OneSelectionFilter" />  
  <includeFilter name="com.ptc.cat.ui.client.internal.action.IsNotUnspecifiedIterationFilter" />  
 </action>


Supported API: true

Extendable: false
Note: This is a GWT client side action which is not supported for extension

  • Method Summary

    Modifier and Type
    Method
    Description
    protected void
    doPostProcessing(com.ptc.cat.entity.client.structure.StructureModel selected_model, List<com.ptc.cat.entity.client.Identifier> added_identifier_list)
    Method that may handle objects on client side after processed by form processor

    Supported API: true
    protected void
    populateActionDefinition(com.ptc.cat.ui.client.action.ActionDefinition action_definition)
    Assign new or change action parameters defined in xml file In example we can change or assign here an url or a processor to the action

    Supported API: true
    protected com.google.gwt.json.client.JSONObject
    populateAdditionalParams(com.google.gwt.json.client.JSONObject result)
    Add additional parameters to request

    Supported API: true
    protected void
    preBuildParams(com.google.gwt.json.client.JSONObject result, com.ptc.cat.ui.client.action.ActionDefinition action_definition)
    Method that can be used to setup some information before any "build params" functions will be called (i.e.
    protected boolean
    trulyPost()
    Method that determines whether wizard action should be opened by submitting form component or by launching url

    Supported API: true

    Methods inherited from class java.lang.Object

    clone, finalize, getClass, notify, notifyAll, wait, wait, wait

  • Method Details

    • populateActionDefinition

      protected void populateActionDefinition(com.ptc.cat.ui.client.action.ActionDefinition action_definition)
      Assign new or change action parameters defined in xml file In example we can change or assign here an url or a processor to the action

      Supported API: true
      Overrides:
      populateActionDefinition in class com.ptc.cat.ui.client.action.JCAAction
      Parameters:
      action_definition - object that contains information about specific action defined in action xml file

    • populateAdditionalParams

      protected com.google.gwt.json.client.JSONObject populateAdditionalParams(com.google.gwt.json.client.JSONObject result)
      Add additional parameters to request

      Supported API: true
      Overrides:
      populateAdditionalParams in class com.ptc.cat.ui.client.action.JCAAction
      Parameters:
      result - object that contains information about parameters and their values that will be used by request
      Returns:
      JSONObject Map of parameters that will be used by request

    • preBuildParams

      protected void preBuildParams(com.google.gwt.json.client.JSONObject result, com.ptc.cat.ui.client.action.ActionDefinition action_definition)
      Method that can be used to setup some information before any "build params" functions will be called (i.e. populateActionDefinition or populateAdditionalParams)

      Supported API: true
      Overrides:
      preBuildParams in class com.ptc.cat.ui.client.action.JCAAction
      Parameters:
      result - object that contains information about parameters and their values that will be used by request
      action_definition - object that contains information about specific action defined in action xml file

    • doPostProcessing

      protected void doPostProcessing(com.ptc.cat.entity.client.structure.StructureModel selected_model, List<com.ptc.cat.entity.client.Identifier> added_identifier_list)
      Method that may handle objects on client side after processed by form processor

      Supported API: true
      Overrides:
      doPostProcessing in class com.ptc.cat.ui.client.action.JCAAction
      Parameters:
      selected_model - object that is a context for action
      added_identifier_list - list of identifiers that was changed by processor

    • trulyPost

      protected boolean trulyPost()
      Method that determines whether wizard action should be opened by submitting form component or by launching url

      Supported API: true
      Overrides:
      trulyPost in class com.ptc.cat.ui.client.action.JCAAction
      Returns:
      boolean