org::scilab::modules::gui::bridge::CallScilabBridge Class Reference

Collaboration diagram for org::scilab::modules::gui::bridge::CallScilabBridge:

Collaboration graph
[legend]

Static Public Member Functions

static String readLine ()
static void display (String dataToDisplay)
static boolean isWaitingForInput ()
static void scilabLinesUpdate ()
static void clear ()
static void clear (int nbLines)
static int getCharWithoutOutput ()
static void toHome ()
static void setPrompt (String prompt)
static void clearHistory ()
static int newWindow ()
static int newMenuBar ()
static int newMenu ()
static int newContextMenu ()
static int newColorChooser ()
static int newFileChooser ()
static int newExportFileChooser (int figureId)
static int newFontChooser ()
static int newMessageBox ()
static int newWaitBar ()
static int newPushButton ()
static int newEditBox ()
static int newLabel ()
static int newCheckBox ()
static int newRadioButton ()
static int newSlider ()
static int newListBox ()
static int newPopupMenu ()
static int newFrame ()
static String displayAndWaitContextMenu (int id)
static void destroyWidget (int id)
static void destroyFrame (int id)
static void setDims (int objID, int width, int height)
static void setWidgetText (int objID, String text)
static String getWidgetText (int objID)
static void setFrameText (int objID, String text)
static String getFrameText (int objID)
static void setFigureAsParent (int figureID, int objID)
static void setPushButtonParent (int figureID, int objID)
static void removePushButtonFromParent (int figureID, int objID)
static void setEditBoxParent (int figureID, int objID)
static void removeEditBoxFromParent (int figureID, int objID)
static void setLabelParent (int figureID, int objID)
static void removeLabelFromParent (int figureID, int objID)
static void setCheckBoxParent (int figureID, int objID)
static void removeCheckBoxFromParent (int figureID, int objID)
static void setRadioButtonParent (int figureID, int objID)
static void removeRadioButtonFromParent (int figureID, int objID)
static void setSliderParent (int figureID, int objID)
static void removeSliderFromParent (int figureID, int objID)
static void setListBoxParent (int figureID, int objID)
static void removeListBoxFromParent (int figureID, int objID)
static void setPopupMenuParent (int figureID, int objID)
static void removePopupMenuFromParent (int figureID, int objID)
static void setFrameParent (int figureID, int objID)
static void removeFrameFromParent (int figureID, int objID)
static void setRootAsParent (int objID)
static void setMenuAsParent (int menuID, int objID)
static void setWidgetCallback (int objID, String callbackString, int callbackType)
static void setFrameCallback (int objID, String callbackString, int callbackType)
static void setFigureMenuEnabled (int figureID, String menuName, boolean status)
static void setFigureSubMenuEnabled (int figureID, String parentMenuName, int menuItemPosition, boolean status)
static void setRootMenuEnabled (String menuName, boolean status)
static void setRootSubMenuEnabled (String parentMenuName, int menuItemPosition, boolean status)
static void removeFigureMenu (int figureID, String menuName)
static void removeRootMenu (String menuName)
static void setFileChooserTitle (int id, String title)
static void setFileChooserInitialDirectory (int id, String path)
static void setFileChooserMask (int id, String mask)
static void fileChooserDisplayAndWait (int id)
static int getFileChooserSelectionSize (int id)
static String[] getFileChooserSelection (int id)
static void setFileChooserDirectorySelectionOnly (int id)
static void setFileChooserFileSelectionOnly (int id)
static void setMessageBoxTitle (int id, String title)
static void setMessageBoxMessage (int id, String message)
static void setMessageBoxMessage (int id, String[] message)
static void messageBoxDisplayAndWait (int id)
static int getMessageBoxSelectedButton (int id)
static void setMessageBoxDefaultSelectedButtons (int id, int[] indices)
static int[] getMessageBoxUserSelectedButtons (int id)
static void setMessageBoxButtonsLabels (int id, String[] labels)
static void setMessageBoxInitialValue (int id, String[] value)
static String[] getMessageBoxValue (int id)
static int getMessageBoxValueSize (int id)
static void setMessageBoxListBoxItems (int id, String[] items)
static int getMessageBoxSelectedItem (int id)
static void setMessageBoxLineLabels (int id, String[] labels)
static void setMessageBoxColumnLabels (int id, String[] labels)
static void setMessageBoxDefaultInput (int id, String[] values)
static void setMessageBoxModal (int id, boolean status)
static void setMessageBoxIcon (int id, String name)
static void setWidgetBackgroundColor (int id, int red, int green, int blue)
static int[] getWidgetBackgroundColor (int id)
static void setWidgetForegroundColor (int id, int red, int green, int blue)
static int[] getWidgetForegroundColor (int id)
static void setFrameBackgroundColor (int id, int red, int green, int blue)
static int[] getFrameBackgroundColor (int id)
static void setFrameForegroundColor (int id, int red, int green, int blue)
static int[] getFrameForegroundColor (int id)
static void setWidgetFontName (int id, String name)
static String getWidgetFontName (int id)
static void setWidgetFontWeight (int id, String weight)
static void setWidgetFontAngle (int id, String angle)
static void setWidgetFontSize (int id, int size)
static int getWidgetFontSize (int id)
static void setFrameFontWeight (int id, String weight)
static void setFrameFontAngle (int id, String angle)
static void setFrameFontSize (int id, int size)
static int getFrameFontSize (int id)
static void setFrameFontName (int id, String name)
static String getFrameFontName (int id)
static void setWidgetPosition (int id, int x, int y, int width, int height)
static int[] getWidgetPosition (int id)
static void setFramePosition (int id, int x, int y, int width, int height)
static int[] getFramePosition (int id)
static void setWidgetHorizontalAlignment (int id, String alignment)
static void setWidgetVerticalAlignment (int id, String alignment)
static void setSliderMinorTickSpacing (int id, int space)
static void setSliderMajorTickSpacing (int id, int space)
static void setSliderMinValue (int id, int value)
static void setSliderMaxValue (int id, int value)
static void setSliderVertical (int id)
static void setSliderHorizontal (int id)
static void setListBoxMultipleSelectionEnabled (int id, boolean status)
static String[] getListBoxAllItemsText (int id)
static int getListBoxNumberOfItems (int id)
static void setListBoxText (int id, String[] text)
static String[] getPopupMenuAllItemsText (int id)
static int getPopupMenuNumberOfItems (int id)
static void setPopupMenuText (int id, String[] text)
static void setListBoxSelectedIndices (int id, int[] indices)
static int[] getListBoxSelectedIndices (int id)
static int getListBoxSelectionSize (int id)
static void setPopupMenuSelectedIndex (int id, int index)
static int getPopupMenuSelectedIndex (int id)
static int getSliderValue (int id)
static void setSliderValue (int id, int value)
static void setRadioButtonChecked (int id, boolean status)
static boolean isRadioButtonChecked (int id)
static void setCheckBoxChecked (int id, boolean status)
static boolean isCheckBoxChecked (int id)
static void setWidgetRelief (int id, String reliefType)
static void setFrameRelief (int id, String reliefType)
static void setToolbarVisible (int figNum, boolean status)
static boolean isToolbarVisible (int figNum)
static void setEventHandler (int figNum, String command)
static void setEventHandlerEnabled (int figNum, boolean status)
static void setWaitBarMessage (int id, String[] message)
static void setWaitBarValue (int id, int value)
static void destroyWaitBar (int id)
static void setWaitBarIndeterminateMode (int id, boolean status)
static void launchHelpBrowser (String[] helps, String language)
static void searchKeyword (String[] helps, String keyword, String language, boolean fullText)
static void closeHelpBrowser ()
static void openScilabWebSite ()
static void openContributionsWebSite ()
static void openBugzillaWebSite ()
static void openNewsgroupWebSite ()
static void selectAllConsoleContents ()
static void copyConsoleSelection ()
static void cutConsoleSelection ()
static void pasteClipboardIntoConsole ()
static void emptyClipboard ()
static void changeConsoleFont ()
static void saveMainWindowSettings ()
static void changeConsoleForeground ()
static void changeConsoleBackground ()
static void printConsoleContents ()
static boolean printString (String theString, String pageHeader)
static boolean printFile (String fileName)
static boolean printFigure (int figID)
static boolean printFigure (int figID, boolean postScript, boolean displayDialog)
static boolean pageSetup ()
static void setFontChooserFontName (int id, String fontName)
static void setFontChooserFontSize (int id, int fontSize)
static void setFontChooserBold (int id, boolean bold)
static void setFontChooserItalic (int id, boolean italic)
static String getFontChooserFontName (int id)
static int getFontChooserFontSize (int id)
static boolean getFontChooserBold (int id)
static boolean getFontChooserItalic (int id)
static void fontChooserDisplayAndWait (int id)
static void setColorChooserTitle (int id, String title)
static void setColorChooserDefaultColor (int id, int[] rgb)
static int[] getColorChooserSelectedColor (int id)
static void colorChooserDisplayAndWait (int id)
static void setWidgetVisible (int id, boolean status)
static void setFrameVisible (int id, boolean status)
static boolean isWidgetVisible (int id)
static boolean isFrameVisible (int id)
static void setWidgetEnable (int id, boolean status)
static void setFrameEnable (int id, boolean status)
static boolean isWidgetEnable (int id)
static boolean isFrameEnable (int id)
static String getClipboardContents ()
static void setClipboardContents (String text)
static void copyFigureToClipBoard (int figID)
static int getScreenResolution ()
static double getScreenWidth ()
static double getScreenHeight ()
static int getScreenDepth ()
static void requestWidgetFocus (int id)
static void requestFrameFocus (int id)
static void raiseWindow (int id)
static boolean isWindowsPlateform ()

Protected Member Functions

 CallScilabBridge ()

Static Private Attributes

static final int NB_COLORS = 3
static final int POSITION_SIZE = 4
static final int X_INDEX = 0
static final int Y_INDEX = 1
static final int WIDTH_INDEX = 2
static final int HEIGHT_INDEX = 3
static final String NORMALFONT = "normal"
static final String OBLIQUEFONT = "oblique"
static final String ITALICFONT = "italic"
static final String BOLDFONT = "bold"
static final int DEFAULTFONTSIZE = 10
static final String DEFAULTFONTNAME = "helvetica"
static final double DEFAULT_RED_BACKGROUND = 0.8 * 255
static final double DEFAULT_GREEN_BACKGROUND = 0.8 * 255
static final double DEFAULT_BLUE_BACKGROUND = 0.8 * 255
static final double BUTTON_RED_BACKGROUND = 0.6 * 255
static final double BUTTON_GREEN_BACKGROUND = 0.6 * 255
static final double BUTTON_BLUE_BACKGROUND = 0.6 * 255
static final double DEFAULT_RED_FOREGROUND = 0
static final double DEFAULT_GREEN_FOREGROUND = 0
static final double DEFAULT_BLUE_FOREGROUND = 0
static PrintRequestAttributeSet scilabPageFormat = new HashPrintRequestAttributeSet()
static String tmpPrinterFile = System.getenv("TMPDIR") + "scilabfigure"

Data Structures

class  ClipboardImage

Detailed Description

This class is used to call Scilab GUIs objects from Scilab
Author:
Vincent COUVERT

Definition at line 107 of file CallScilabBridge.java.

Constructor & Destructor Documentation

org::scilab::modules::gui::bridge::CallScilabBridge::CallScilabBridge (  )  [inline, protected]

Constructor

Definition at line 143 of file CallScilabBridge.java.

00143                                      {
00144                 throw new UnsupportedOperationException(); /* Prevents calls from subclass */
00145         }

Member Function Documentation

static String org::scilab::modules::gui::bridge::CallScilabBridge::readLine (  )  [inline, static]

Read a line from the Console

Returns:
the line read

Definition at line 157 of file CallScilabBridge.java.

00157                                         {
00158                 return ScilabConsole.getConsole().readLine();
00159         }

static void org::scilab::modules::gui::bridge::CallScilabBridge::display ( String  dataToDisplay  )  [inline, static]

Display a line in the Console

Parameters:
dataToDisplay the line to display

Definition at line 165 of file CallScilabBridge.java.

00165                                                          {
00166                 ScilabConsole.getConsole().display(dataToDisplay);
00167         }

static boolean org::scilab::modules::gui::bridge::CallScilabBridge::isWaitingForInput (  )  [inline, static]

Get the status of the Console

Returns:
true if the console is at the prompt

Definition at line 173 of file CallScilabBridge.java.

00173                                                   {
00174                 return ScilabConsole.getConsole().isWaitingForInput();
00175         }

static void org::scilab::modules::gui::bridge::CallScilabBridge::scilabLinesUpdate (  )  [inline, static]

Update the number of lines and columns that Scilab use to format data to display

Definition at line 180 of file CallScilabBridge.java.

00180                                                {
00181                 ScilabConsole.getConsole().scilabLinesUpdate();
00182         }

static void org::scilab::modules::gui::bridge::CallScilabBridge::clear (  )  [inline, static]

Clear the Console

Definition at line 187 of file CallScilabBridge.java.

00187                                    {
00188                 ScilabConsole.getConsole().clear();
00189         }

static void org::scilab::modules::gui::bridge::CallScilabBridge::clear ( int  nbLines  )  [inline, static]

Clear some lines in the Console

Parameters:
nbLines the number of lines to clear

Definition at line 195 of file CallScilabBridge.java.

00195                                               {
00196                 ScilabConsole.getConsole().clear(nbLines);
00197         }

static int org::scilab::modules::gui::bridge::CallScilabBridge::getCharWithoutOutput (  )  [inline, static]

Get a char to know if the user wants more data to be displayed

Returns:
the user answer

Definition at line 203 of file CallScilabBridge.java.

00203                                                  {
00204                 return ScilabConsole.getConsole().getAsSimpleConsole().getCharWithoutOutput();
00205         }

static void org::scilab::modules::gui::bridge::CallScilabBridge::toHome (  )  [inline, static]

Put the prompt on the top left corner

Definition at line 210 of file CallScilabBridge.java.

00210                                     {
00211                 ScilabConsole.getConsole().toHome();
00212         }

static void org::scilab::modules::gui::bridge::CallScilabBridge::setPrompt ( String  prompt  )  [inline, static]

Set the contents of the prompt

Parameters:
prompt the content to set (default is -->)

Definition at line 218 of file CallScilabBridge.java.

00218                                                     {
00219                 ScilabConsole.getConsole().setPrompt(prompt);
00220         }

static void org::scilab::modules::gui::bridge::CallScilabBridge::clearHistory (  )  [inline, static]

Clear the commands history

Definition at line 225 of file CallScilabBridge.java.

00225                                           {
00226                 ScilabConsole.getConsole().clearHistory();
00227         }

static int org::scilab::modules::gui::bridge::CallScilabBridge::newWindow (  )  [inline, static]

Create a new Window in Scilab GUIs

Returns:
the ID of the window in the UIElementMapper

Definition at line 239 of file CallScilabBridge.java.

00239                                       {
00240                 Window window = ScilabWindow.createWindow();
00241                 return UIElementMapper.add(window);
00242         }

static int org::scilab::modules::gui::bridge::CallScilabBridge::newMenuBar (  )  [inline, static]

Create a new Menubar in Scilab GUIs

Returns:
the ID of the Menubar in the UIElementMapper

Definition at line 248 of file CallScilabBridge.java.

00248                                        {
00249                 MenuBar menuBar = ScilabMenuBar.createMenuBar();
00250                 return UIElementMapper.add(menuBar);
00251         }

static int org::scilab::modules::gui::bridge::CallScilabBridge::newMenu (  )  [inline, static]

Create a new Menu in Scilab GUIs

Returns:
the ID of the menu in the UIElementMapper

Definition at line 257 of file CallScilabBridge.java.

00257                                     {
00258                 MenuItem menuItem = ScilabMenuItem.createMenuItem();
00259                 return UIElementMapper.add(menuItem);
00260         }

static int org::scilab::modules::gui::bridge::CallScilabBridge::newContextMenu (  )  [inline, static]

Create a new ContextMenu in Scilab GUIs

Returns:
the ID of the ContextMenu in the UIElementMapper

Definition at line 266 of file CallScilabBridge.java.

00266                                            {
00267                 ContextMenu contextMenu = ScilabContextMenu.createContextMenu();
00268                 return UIElementMapper.add(contextMenu);
00269         }

static int org::scilab::modules::gui::bridge::CallScilabBridge::newColorChooser (  )  [inline, static]

Create a new Color Chooser in Scilab GUIs

Returns:
the ID of the Color Chooser in the UIElementMapper

Definition at line 275 of file CallScilabBridge.java.

00275                                             {
00276                 ColorChooser colorChooser = ScilabColorChooser.createColorChooser();
00277                 return UIElementMapper.add(colorChooser);
00278         }

static int org::scilab::modules::gui::bridge::CallScilabBridge::newFileChooser (  )  [inline, static]

Create a new File Chooser in Scilab GUIs

Returns:
the ID of the File Chooser in the UIElementMapper

Definition at line 283 of file CallScilabBridge.java.

00283                                            {
00284                 FileChooser fileChooser = ScilabFileChooser.createFileChooser();
00285                 return UIElementMapper.add(fileChooser);
00286         }

static int org::scilab::modules::gui::bridge::CallScilabBridge::newExportFileChooser ( int  figureId  )  [inline, static]

Create a new Graphic Export File Chooser in Scilab GUIs

Parameters:
figureId id of the figure to export
Returns:
the ID of the File Chooser in the UIElementMapper

Definition at line 293 of file CallScilabBridge.java.

00293                                                              {
00294                 FileChooser fileChooser = ScilabFileChooser.createExportFileChooser(figureId);
00295                 return UIElementMapper.add(fileChooser);
00296         }

static int org::scilab::modules::gui::bridge::CallScilabBridge::newFontChooser (  )  [inline, static]

Create a new Font Chooser in Scilab GUIs

Returns:
the ID of the Font Chooser in the UIElementMapper

Definition at line 302 of file CallScilabBridge.java.

00302                                            {
00303                 FontChooser fontChooser = ScilabFontChooser.createFontChooser();
00304                 return UIElementMapper.add(fontChooser);
00305         }

static int org::scilab::modules::gui::bridge::CallScilabBridge::newMessageBox (  )  [inline, static]

Create a new MessageBox in Scilab GUIs

Returns:
the ID of the MessageBox in the UIElementMapper

Definition at line 311 of file CallScilabBridge.java.

00311                                           {
00312                 MessageBox messageBox = ScilabMessageBox.createMessageBox();
00313                 return UIElementMapper.add(messageBox);
00314         }

static int org::scilab::modules::gui::bridge::CallScilabBridge::newWaitBar (  )  [inline, static]

Create a new WaitBar in Scilab GUIs

Returns:
the ID of the WaitBar in the UIElementMapper

Definition at line 320 of file CallScilabBridge.java.

00320                                        {
00321                 WaitBar waitBar = ScilabWaitBar.createWaitBar();
00322                 return UIElementMapper.add(waitBar);
00323         }

static int org::scilab::modules::gui::bridge::CallScilabBridge::newPushButton (  )  [inline, static]

Create a new PushButton in Scilab GUIs

Returns:
the ID of the PushButton in the UIElementMapper

Definition at line 329 of file CallScilabBridge.java.

References BUTTON_BLUE_BACKGROUND, BUTTON_GREEN_BACKGROUND, BUTTON_RED_BACKGROUND, DEFAULT_BLUE_FOREGROUND, DEFAULT_GREEN_FOREGROUND, DEFAULT_RED_FOREGROUND, DEFAULTFONTNAME, DEFAULTFONTSIZE, NORMALFONT, setWidgetBackgroundColor(), setWidgetFontName(), setWidgetFontSize(), setWidgetFontWeight(), setWidgetForegroundColor(), and setWidgetRelief().

00329                                           {
00330                 PushButton pushButton = ScilabPushButton.createPushButton();
00331                 int id = UIElementMapper.add(pushButton);
00332                 
00333                 /* Default font */
00334                 setWidgetFontName(id, DEFAULTFONTNAME);
00335                 setWidgetFontWeight(id, NORMALFONT);
00336                 setWidgetFontSize(id, DEFAULTFONTSIZE);
00337                 
00338                 setWidgetRelief(id, ScilabRelief.RAISED);
00339                 
00340                 /* Default colors */
00341                 setWidgetBackgroundColor(id, (int) BUTTON_RED_BACKGROUND, (int) BUTTON_GREEN_BACKGROUND, (int) BUTTON_BLUE_BACKGROUND);
00342                 setWidgetForegroundColor(id, (int) DEFAULT_RED_FOREGROUND, (int) DEFAULT_GREEN_FOREGROUND, (int) DEFAULT_BLUE_FOREGROUND);
00343                 return id;
00344         }

Here is the call graph for this function:

static int org::scilab::modules::gui::bridge::CallScilabBridge::newEditBox (  )  [inline, static]

Create a new EditBox in Scilab GUIs

Returns:
the ID of the Edit in the UIElementMapper

Definition at line 350 of file CallScilabBridge.java.

References DEFAULT_BLUE_BACKGROUND, DEFAULT_BLUE_FOREGROUND, DEFAULT_GREEN_BACKGROUND, DEFAULT_GREEN_FOREGROUND, DEFAULT_RED_BACKGROUND, DEFAULT_RED_FOREGROUND, DEFAULTFONTNAME, DEFAULTFONTSIZE, NORMALFONT, setWidgetBackgroundColor(), setWidgetFontName(), setWidgetFontSize(), setWidgetFontWeight(), setWidgetForegroundColor(), and setWidgetRelief().

00350                                        {
00351                 EditBox editBox = ScilabEditBox.createEditBox();
00352                 int id = UIElementMapper.add(editBox);
00353                 
00354                 /* Default font */
00355                 setWidgetFontName(id, DEFAULTFONTNAME);
00356                 setWidgetFontWeight(id, NORMALFONT);
00357                 setWidgetFontSize(id, DEFAULTFONTSIZE);
00358                 
00359                 setWidgetRelief(id, ScilabRelief.SUNKEN);
00360                 
00361                 /* Default colors */
00362                 setWidgetBackgroundColor(id, (int) DEFAULT_RED_BACKGROUND, (int) DEFAULT_GREEN_BACKGROUND, (int) DEFAULT_BLUE_BACKGROUND);
00363                 setWidgetForegroundColor(id, (int) DEFAULT_RED_FOREGROUND, (