Package com.inductiveautomation.vision.api.client.components.model

Class CustomFunction

  • public class CustomFunction
extends java.lang.Object

    • Field Summary

      Fields 
      Modifier and Type Field Description
      static java.lang.String CACHE_KEY  
      static java.lang.String CLIENT_KEY  

    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      static java.lang.String buildScriptHeader​(java.lang.String name, java.util.List<java.lang.String> paramList)  
      static void clearCache​(javax.swing.JComponent component)  
      boolean equals​(java.lang.Object obj)  
      static java.util.Map<java.lang.String,​java.lang.String> get​(javax.swing.JComponent component)
      Returns this component's map of function name -> script source.
      static java.util.Map<java.lang.String,​org.python.core.PyMethod> getCache​(javax.swing.JComponent component)
      Returns a map of the compiled PyMethods associated with this component's custom functions.
      java.lang.String getName()  
      java.util.List<java.lang.String> getParams()  
      java.lang.String getScript()  
      static boolean hasCustomFunctions​(javax.swing.JComponent component)  
      static boolean hasMethodName​(javax.swing.JComponent component, java.lang.String functionName)
      Returns true if the given component contains functionName in its Java class' method names.
      static java.lang.String parseBody​(java.lang.String script)  
      static java.lang.String parseName​(java.lang.String script)  
      static java.util.List<java.lang.String> parseParams​(java.lang.String script)
      Given an entire script, parse the params into a list of strings
      static java.util.List<java.lang.String> parseParamsDirect​(java.lang.String parsedParams)  
      static void put​(javax.swing.JComponent component, java.util.Map<java.lang.String,​java.lang.String> functions)  
      void setName​(java.lang.String name)  
      void setParams​(java.util.List<java.lang.String> params)  
      void setScript​(java.lang.String script)  

      • Methods inherited from class java.lang.Object

        clone, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

    • Constructor Detail

      • CustomFunction

        public CustomFunction()

      • CustomFunction

        public CustomFunction​(java.lang.String script)

    • Method Detail

      • parseName

        public static java.lang.String parseName​(java.lang.String script)

      • parseParams

        public static java.util.List<java.lang.String> parseParams​(java.lang.String script)
        Given an entire script, parse the params into a list of strings

      • parseParamsDirect

        public static java.util.List<java.lang.String> parseParamsDirect​(java.lang.String parsedParams)

      • parseBody

        public static java.lang.String parseBody​(java.lang.String script)

      • buildScriptHeader

        public static java.lang.String buildScriptHeader​(java.lang.String name,
                                                 java.util.List<java.lang.String> paramList)

      • getScript

        public java.lang.String getScript()

      • setScript

        public void setScript​(java.lang.String script)

      • getName

        public java.lang.String getName()

      • setName

        public void setName​(java.lang.String name)

      • getParams

        public java.util.List<java.lang.String> getParams()

      • setParams

        public void setParams​(java.util.List<java.lang.String> params)

      • get

        public static java.util.Map<java.lang.String,​java.lang.String> get​(javax.swing.JComponent component)
        Returns this component's map of function name -> script source.

        Note that this map is serialized on each component. See DefaultComponentDelegate

      • put

        public static void put​(javax.swing.JComponent component,
                       java.util.Map<java.lang.String,​java.lang.String> functions)

      • getCache

        public static java.util.Map<java.lang.String,​org.python.core.PyMethod> getCache​(javax.swing.JComponent component)
        Returns a map of the compiled PyMethods associated with this component's custom functions. If a function hasn't been called yet, in may not be in this cache.

        See PyComponentWrapper#customFunctionToPyMethod

      • clearCache

        public static void clearCache​(javax.swing.JComponent component)

      • equals

        public boolean equals​(java.lang.Object obj)
        Overrides:
        equals in class java.lang.Object

      • hasMethodName

        public static boolean hasMethodName​(javax.swing.JComponent component,
                                    java.lang.String functionName)
        Returns true if the given component contains functionName in its Java class' method names.

      • hasCustomFunctions

        public static boolean hasCustomFunctions​(javax.swing.JComponent component)