Package com.inductiveautomation.rm.base

Class RMExtras

  • public class RMExtras
extends java.lang.Object
    This file is just meant to hold various utility methods that customers have asked for.

    • Constructor Summary

      Constructors 
      Constructor Description
      RMExtras()  

    • Method Summary

      All Methods Static Methods Concrete Methods 
      Modifier and Type Method Description
      static void addPageBetweenPages()
      An example of adding a static page between all pages (and at the end) to effectively provide a page back when printing front and back.
      static void addToPage​(RMDocument aDoc1, RMDocument aDoc2)
      Adds the contents from second document to the bottom of the first page of first document.
      static java.lang.StringBuffer getImageMap​(RMShape aShape, java.lang.StringBuffer aSB)
      Returns a StringBuffer image map for a given shape.
      static java.util.List<RMExtras.Movie> getMovies()
      Returns a list of movies.
      static void main​(java.lang.String[] args)
      Writes a movie dataset to file.
      static void main2​(java.lang.String[] args)  
      static void passwordReport()
      Set PDF password.
      static void printNames​(RMShape aShape)
      Prints name of every shape in a template hierarchy.
      static void printNames​(RMTableGroup aTableGroup, RMTable aTable)
      Prints name of every shape in table group hierarchy.
      static void replaceDatasetKey​(RMShape aShape, java.lang.String aKey1, java.lang.String aKey2)
      Replaces any dataset key in template that matches first given dataset key with the second given dataset key.
      static void replaceFormat​(RMShape aShape, RMFormat aFormat)
      Replaces a format.
      static void replaceGroupingKey​(RMShape aShape, java.lang.String aKey1, java.lang.String aKey2)
      Replaces any grouping key in the template that matches first given key with the second given key.
      static void replaceSort​(RMShape aShape, java.lang.String aSort1, java.lang.String aSort2)
      Replaces any sort in the template that matches first given sort with the second given sort.
      static void replaceText​(RMShape aShape, java.lang.String aString1, java.lang.String aString2)
      Iterates over all document (or shape) text and replaces occurrences of the first string with the second.
      static void setTimeZone​(RMShape aShape, java.util.TimeZone aTimeZone)
      Sets the time zone for a document.
      static void writeMoviesDataset()
      Writes a movie dataset to file.

      • Methods inherited from class java.lang.Object

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

    • Constructor Detail

      • RMExtras

        public RMExtras()

    • Method Detail

      • replaceText

        public static void replaceText​(RMShape aShape,
                               java.lang.String aString1,
                               java.lang.String aString2)
        Iterates over all document (or shape) text and replaces occurrences of the first string with the second.

      • replaceDatasetKey

        public static void replaceDatasetKey​(RMShape aShape,
                                     java.lang.String aKey1,
                                     java.lang.String aKey2)
        Replaces any dataset key in template that matches first given dataset key with the second given dataset key.

      • replaceGroupingKey

        public static void replaceGroupingKey​(RMShape aShape,
                                      java.lang.String aKey1,
                                      java.lang.String aKey2)
        Replaces any grouping key in the template that matches first given key with the second given key.

      • replaceSort

        public static void replaceSort​(RMShape aShape,
                               java.lang.String aSort1,
                               java.lang.String aSort2)
        Replaces any sort in the template that matches first given sort with the second given sort.

      • replaceFormat

        public static void replaceFormat​(RMShape aShape,
                                 RMFormat aFormat)
        Replaces a format.

      • getImageMap

        public static java.lang.StringBuffer getImageMap​(RMShape aShape,
                                                 java.lang.StringBuffer aSB)
        Returns a StringBuffer image map for a given shape.

      • printNames

        public static void printNames​(RMShape aShape)
        Prints name of every shape in a template hierarchy.

      • printNames

        public static void printNames​(RMTableGroup aTableGroup,
                              RMTable aTable)
        Prints name of every shape in table group hierarchy.

      • addToPage

        public static void addToPage​(RMDocument aDoc1,
                             RMDocument aDoc2)
        Adds the contents from second document to the bottom of the first page of first document.

      • addPageBetweenPages

        public static void addPageBetweenPages()
        An example of adding a static page between all pages (and at the end) to effectively provide a page back when printing front and back.

      • setTimeZone

        public static void setTimeZone​(RMShape aShape,
                               java.util.TimeZone aTimeZone)
        Sets the time zone for a document.

      • passwordReport

        public static void passwordReport()
        Set PDF password.

      • getMovies

        public static java.util.List<RMExtras.Movie> getMovies()
        Returns a list of movies.

      • writeMoviesDataset

        public static void writeMoviesDataset()
        Writes a movie dataset to file.

      • main

        public static void main​(java.lang.String[] args)
        Writes a movie dataset to file.

      • main2

        public static void main2​(java.lang.String[] args)