Class WebExportParameters

    • Field Detail

      • backgroundColor

        public ColorAttribute backgroundColor
        Background color. By default this is blank, which indicates to use the background color of the model.
      • copyJavaScriptFiles

        public Parameter copyJavaScriptFiles
        If true, then make an exported web page stand alone. Instead of referencing JavaScript and image files on the ptolemy.org website, if this parameter is true, then the required files will be copied into the target directory. This is a boolean that defaults to false.
      • directoryToExportTo

        public FileParameter directoryToExportTo
        The directory to export to. If a relative name is given, then it is relative to the location of the model file. By default, this is blank, which will result in writing to a directory with name equal to the sanitized name of the model, and the directory will be contained in the same location where the model that contains this attribute is stored.
      • imageFormat

        public StringParameter imageFormat
        The image format to use, which can be one of "gif" (the default), "png", or "jpg".
      • openCompositesBeforeExport

        public Parameter openCompositesBeforeExport
        If true, hierarchically open all composite actors in the model before exporting (so that these also get exported, and hyperlinks to them are created). This is a boolean that defaults to false.
      • runBeforeExport

        public Parameter runBeforeExport
        If true, run the model before exporting (to open plotter or other display windows that get exported). Note that it is important the model have a finite run. This is a boolean that defaults to false.
      • showInBrowser

        public Parameter showInBrowser
        If true, open a web browser to display the resulting export. This is a boolean that defaults to true.
      • usePtWebsite

        public Parameter usePtWebsite
        If true, use the server-side includes of the Ptolemy website. This is a boolean that defaults to false. This parameter is marked as an expert parameter, so by default, it is not visible.
    • Constructor Detail

      • WebExportParameters

        public WebExportParameters​(NamedObj container,
                                   java.lang.String name)
                            throws IllegalActionException,
                                   NameDuplicationException
        Construct an attribute with the given name contained by the specified entity.
        Parameters:
        container - The container.
        name - The name of this attribute.
        Throws:
        IllegalActionException - If the attribute is not of an acceptable class for the container, or if the name contains a period.
        NameDuplicationException - If the name coincides with an attribute already in the container.
    • Method Detail

      • getExportParameters

        public ExportParameters getExportParameters()
        Return the current parameter values in a data structure. If a file name has not been specified, then substitute the sanitized model name.
        Returns:
        The current parameter values.
      • parametersChanged

        public boolean parametersChanged()
        Return true if the parameter values are different from the defaults.
        Returns:
        True if the parameter values are different from the defaults.