|
|
|
|
|
Call a method from the Methods list by using its name, for example, method1(), method2().
|
|
|
Alternate way to call a method from the Methods list; used internally and in cases of name collisions.
|
|
useGraphics(ModelEntity entity, String name)
useGraphics(ModelEntity entity, FormObject graphics)
|
Plots the given entity (Plot Group, Geometry, Mesh, Explicit Selection or Player Animation) in the graphics form object given by the name, name path, or graphics form object in the second argument.
|
|
|
Shows the form with the given name in the current main window. In a single window application, the form replaces the current one. In an application with subwindows, the form must exist in the main window layout. If not, it will not be opened. Showing a form that is already open will only activate the form.
|
|
|
Closes the form with the given name. Closing forms is only possible in applications using subwindows. This method is not applicable for single window applications.
|
|
|
Closes the form, shown as a dialog box, with the given name.
|
|
|
Shows the form with the given name as a dialog box. Equivalent to the dialog method of a Form object; see below.
|
|
|
Stops execution and displays an alert message with the given text.
|
|
alert(String text, String title)
|
Stops execution and displays an alert message with the given text and title.
|
|
String confirm(String text)
|
Stops execution and displays a confirmation dialog box with the given text. It also displays two buttons, “Yes” and “No”. The method returns “Yes” or “No” depending on what the user clicks.
|
|
String confirm(String text, String title)
|
Stops execution and displays a confirmation dialog box with the given text and title. It also displays two buttons, “Yes” and “No”. The method returns “Yes” or “No” depending on what the user clicks.
|
|
String confirm(String text, String title, String yes, String no)
|
Stops execution and displays a confirmation dialog box with the given text and title. It also displays two buttons with the given strings as labels. The method returns the label of the button that the user clicks.
|
|
String confirm(String text, String title, String yes, String no, String cancel)
|
Stops execution and displays a confirmation dialog box with the given text and title. It also displays three buttons with the given strings as labels. The method returns the label of the button that the user clicks.
|
|
|
Stops execution and opens an error dialog box with the given message.
|
|
error(String message, Throwable cause)
|
Stops execution and opens an error dialog box with the given message including the underlying cause of class Throwable, the general Java exception class, or one of its subclasses, such as RuntimeException. This can be used to “wrap” native COMSOL Multiphysics error messages with custom error messages.
|
|
String request(String text)
|
Stops execution and displays a dialog box with a text field, requesting input from the user. The given text is the label of the text field. The method returns the entered text or null if the cancel button is clicked.
|
|
String request(String text, String defaultString)
|
Stops execution and displays a dialog box with a text field, requesting input from the user. The given text is the label of the text field and the default string is the text initially shown in the text field. The method returns the entered text or null if the cancel button is clicked.
|
|
String request(String text, String title, String defaultString)
|
Stops execution and displays a dialog box with a text field, requesting input from the user. The given text is the label of the text field, the default string is the text initially shown in the text field, and the title is the title of the dialog box. The method returns the entered text or null if the cancel button is clicked.
|
|
|
Sends a message to the message log if available in the application.
|
|
|
Sends a message arg to the message log. For an application this requires that a message log is added to the application user interface. The input argument arg can be a scalar, 1D array, or 2D array of the types string, double, int or Boolean.
|
|
|
|
|
|
Clears the message log window.
|
|
evaluateToResultsTable(NumericalFeature entity, String name, boolean clear)
evaluateToResultsTable(NumericalFeature entity, FormObject graphics, boolean clear)
|
Evaluates the given entity, a Derived Value, in the table object given by the name, name path, or graphics form object in the second argument, which will then be the default target for the evaluations of the Derived Value. If the third argument is true, the table is cleared before adding the new data, otherwise the data is appended.
|
|
double[][] evaluateToDoubleArray2D(NumericalFeature entity)
|
Evaluates the given entity, a Derived Value, and returns the non-parameter column part of the real table that is produced as a double matrix. All settings in the numerical feature are respected, but those in the current table connected to the numerical feature are ignored.
|
|
int[][] evaluateToIntegerArray2D(NumericalFeature entity)
|
Evaluates the given entity, a Derived Value, and returns the non-parameter column part of the real table that is produced as an integer matrix. All settings in the numerical feature are respected, but those in the current table connected to the numerical feature are ignored.
|
|
String[][] evaluateToStringArray2D(NumericalFeature entity)
|
Evaluates the given entity, a Derived Value, and returns the non-parameter column part of the, potentially complex, table that is produced as a string matrix. All settings in the numerical feature are respected but those in the current table connected to the numerical feature are ignored.
|
|
useResultsTable(TableFeature tableFeature, String resultsTable)
useResultsTable(TableFeature tableFeature, FormObject resultsTable)
|
Shows the values from the tableFeature in the resultsTable form object.
|
|
ChoiceList getChoiceList(String name)
|
Returns an object of the type ChoiceList, representing a choice list node under the declarations branch. The type ChoiceList has methods that make it easier to change the matrix value with respect to changing and accessing values and display names individually.
|
|
setFormObjectEnabled(String name, boolean enabled)
|
Sets the enable state for the form object specified by the name or name path.
|
|
setFormObjectVisible(String name, boolean visible)
|
Sets the visible state for the form object specified by the name or name path.
|
|
setFormObjectText(String name, String text)
|
Sets the text for the form object specified by the name or name path in the second argument. This method throws an error if it is impossible to set a text for the specified form object.
|
|
setFormObjectEditable(String name, boolean editable)
|
Sets the editable state for the form object specified by the name or name path. This functionality is only available for text field objects.
|
|
setMenuBarItemEnabled(String name, boolean enabled)
|
Sets the enable state for the menu bar item specified by the name or name path (from menu bar) in the first argument.
|
setMainToolbarItemEnabled
|
setMainToolbarItemEnabled(String name, boolean enabled)
|
Sets the enable state for the main toolbar item specified by the name or name path (from main toolbar) in the first argument.
|
|
setFileMenuItemEnabled(String name, boolean enabled)
|
Sets the enable state for the file menu item specified by the name or name path (from file menu) in the first argument.
|
|
setRibbonItemEnabled(String name, boolean enabled)
|
Sets the enable state for the ribbon item specified by the name or name path (from main window) in the first argument.
|
|
setToolbarItemEnabled(String name, boolean enabled)
|
Sets the enable state for the toolbar form object item specified by the name or name path in the first argument.
|
|
useView(View view, String name)
useView(View view, FormObject graphics)
|
Applies a view to the graphics contents given by the name, name path, or graphics form object in the second argument.
|
|
resetView(String name)
resetView(FormObject graphics)
|
Resets the view to its initial state in the graphics contents given by the name, name path, or graphics form object in the second argument.
|
|
ViewBase getView(String name)
ViewBase getView(FormObject graphics)
|
Returns the view currently used by the graphics contents given by the name, name path, or graphics form object in the second argument.
|
|
|
Goes to a standard view in main graphics window. The parameter name is one of the view orientation strings in the following list: “xy”,”xz”,”yx”,”yz”,”zx”,”zy”.
|
|
goToView(String name, String graphicsname);
|
Goes to a standard view in the given graphics form object graphicsname.
|
|
goToView(String name, FormObject graphics);
|
Goes to standard view in the given graphics form object graphics.
|
|
setWebPageSource(String name, String source)
|
Sets the source for the form object specified by the name or name path in the first argument. This method throws an error if the name does not refer to a Web Page form object.
|
|
|
Returns the height in pixels of the primary screen on client system, or of the browser window if Web Client is used.
|
|
|
Returns the width in pixels of the primary screen on client system, or of the browser window if Web Client is used.
|
|
storeChanges(String form)
|
Commits the values entered in a dialog box having On request enabled. The method takes the name of the form as its argument.
|