Deprecated API

Contents

• Deprecated Classes
• Deprecated Fields
• Deprecated Methods

Deprecated Classes

Class and Description
org.eclipse.scout.rt.client.ui.wizard.LegacyHtmlStatusWizardContainerForm This form uses a HTML provider to indicate the wizard progress. It should be replaced by DefaultWizardContainerForm which uses a AbstractWizardProgressField instead. This class will be deleted in the O-Release.

Deprecated Fields

Field and Description
org.eclipse.scout.rt.client.ui.form.fields.groupbox.IGroupBox.BORDER_DECORATION_SECTION This decoration type is obsolete, do not use it anymore. This constant will be removed in the "O" release. To apply the "section style" to a group box, set its "expandable" property to true and set a decoration style that supports expandable group boxes (e.g. IGroupBox.BORDER_DECORATION_LINE). In most cases, IGroupBox.BORDER_DECORATION_AUTO is also acceptable. (Thus, the easiest way to migrate is probably to just remove your getConfiguredBorderDecoration() declaration, thus falling back to the default BORDER_DECORATION_AUTO).
org.eclipse.scout.rt.client.ui.desktop.DesktopEvent.TYPE_FILE_CHOOSER_ADDED use DesktopEvent.TYPE_FILE_CHOOSER_SHOW; will be removed in version 6.1.
org.eclipse.scout.rt.client.ui.desktop.DesktopEvent.TYPE_FORM_ADDED use DesktopEvent.TYPE_FORM_SHOW; will be removed in version 6.1.
org.eclipse.scout.rt.client.ui.desktop.DesktopEvent.TYPE_FORM_ENSURE_VISIBLE use DesktopEvent.TYPE_FORM_ACTIVATE; will be removed in version 6.1.
org.eclipse.scout.rt.client.ui.desktop.DesktopEvent.TYPE_FORM_REMOVED use DesktopEvent.TYPE_FORM_HIDE; will be removed in version 6.1.
org.eclipse.scout.rt.client.ui.desktop.DesktopEvent.TYPE_MESSAGE_BOX_ADDED use DesktopEvent.TYPE_MESSAGE_BOX_SHOW; will be removed in version 6.1.
org.eclipse.scout.rt.client.ui.desktop.DesktopEvent.TYPE_MESSAGE_BOX_REMOVED use DesktopEvent.TYPE_MESSAGE_BOX_HIDE; will be removed in version 6.1.

Deprecated Methods

Method and Description
org.eclipse.scout.rt.client.ui.desktop.IDesktop.addFileChooser(IFileChooser) use IDesktop.showFileChooser(IFileChooser); will be removed in version 6.1.
org.eclipse.scout.rt.client.ui.desktop.IDesktop.addForm(IForm) use IDesktop.showForm(IForm); will be removed in version 6.1.
org.eclipse.scout.rt.client.ui.desktop.IDesktop.addMessageBox(IMessageBox) use IDesktop.showMessageBox(IMessageBox); will be removed in version 6.1.
org.eclipse.scout.rt.client.ui.wizard.IWizard.doHyperlinkAction(URL, String, boolean) use IWizard.doAppLinkAction(String) instead
org.eclipse.scout.rt.client.ui.desktop.IDesktop.ensureVisible(IForm) use IDesktop.activateForm(IForm); will be removed in version 6.1.
org.eclipse.scout.rt.client.ui.form.fields.htmlfield.AbstractHtmlField.execHyperlinkAction(URL, String, boolean) use AbstractHtmlField.execAppLinkAction(String) instead
org.eclipse.scout.rt.client.ui.wizard.AbstractWizard.execHyperlinkAction(URL, String, boolean) use AbstractWizard.execAppLinkAction(String) instead
org.eclipse.scout.rt.client.ui.basic.table.AbstractTable.execHyperlinkAction(URL, String, boolean)
org.eclipse.scout.rt.client.ui.form.fields.datefield.AbstractDateField.execParseValue(String) This method is never called for IDateField. The UI is responsible for parsing a date.
org.eclipse.scout.rt.client.ui.form.fields.AbstractValueField.getConfiguredAutoDisplayText() no replacement. Will be removed in the O-Release. Indicates whether setting the field's value results in an update of the display text.
org.eclipse.scout.rt.client.ui.form.fields.smartfield.AbstractContentAssistField.getConfiguredAutoDisplayText() no replacement. Will be removed in the O-Release.
org.eclipse.scout.rt.client.ui.wizard.AbstractWizardStep.getConfiguredDescriptionHtml() use getConfiguredSubTitle()
org.eclipse.scout.rt.client.ui.wizard.AbstractWizardStep.getConfiguredTitleHtml() use getConfiguredTitle()
org.eclipse.scout.rt.client.ui.wizard.AbstractWizardStep.getDescriptionHtml()
org.eclipse.scout.rt.client.ui.wizard.IWizardStep.getDescriptionHtml() Use getSubTitle()
org.eclipse.scout.rt.client.ui.desktop.IDesktop.getDialogStack() use IDesktop.getDialogs(); will be removed in version 6.1.
org.eclipse.scout.rt.client.ui.action.menu.root.ContextMenuEvent.getEventType() use #getType()
org.eclipse.scout.rt.client.ui.desktop.IDesktop.getFileChooserStack() use IDesktop.getFileChoosers(); will be removed in version 6.1.
org.eclipse.scout.rt.client.ui.basic.table.ITable.getMenu(Class<T>) Use IContextMenuOwner.getMenuByClass(Class) instead. This method is error-prone, because it does not throw an exception if the given menu type is ambiguous. It will be removed in the O-Release (7.0).
org.eclipse.scout.rt.client.ui.basic.table.AbstractTable.getMenu(Class<T>)
org.eclipse.scout.rt.client.ui.basic.tree.ITree.getMenu(Class<T>) Use IContextMenuOwner.getMenuByClass(Class) instead. This method is error-prone, because it does not throw an exception if the given menu type is ambiguous. It will be removed in the O-Release (7.0).
org.eclipse.scout.rt.client.ui.basic.tree.AbstractTree.getMenu(Class<T>)
org.eclipse.scout.rt.client.ui.desktop.IDesktop.getMessageBoxStack() use IDesktop.getMessageBoxes(); will be removed in version 6.1.
org.eclipse.scout.rt.client.ui.wizard.AbstractWizardStep.getTitleHtml()
org.eclipse.scout.rt.client.ui.wizard.IWizardStep.getTitleHtml() Use getTitle()
org.eclipse.scout.rt.client.ui.desktop.IDesktop.getViewStack() use IDesktop.getViews(); will be removed in version 6.1.
org.eclipse.scout.rt.client.IClientSession.getVirtualDesktop() use IClientSession.getDesktopElseVirtualDesktop(); will be removed in version 6.1.
org.eclipse.scout.rt.client.ui.form.IForm.isAutoAddRemoveOnDesktop() use IForm.isShowOnStart(); will be removed in version 6.1.
org.eclipse.scout.rt.client.ui.form.fields.AbstractValueField.isAutoDisplayText() no replacement. Will be removed in the O-Release.
org.eclipse.scout.rt.client.ui.form.IForm.isFormOpen() use IForm.isFormStarted(); will be removed in version 6.1.
org.eclipse.scout.rt.client.ui.form.fields.IValueField.parseValue(String) Will be removed with scout 7. Use IValueField.parseAndSetValue(String)
org.eclipse.scout.rt.client.ui.form.fields.AbstractValueField.parseValue(String) use AbstractValueField.parseAndSetValue(String)
org.eclipse.scout.rt.client.ui.desktop.IDesktop.removeForm(IForm) use IDesktop.hideForm(IForm); will be removed in version 6.1.
org.eclipse.scout.rt.client.ui.desktop.IDesktop.removeMessageBox(IMessageBox) use IDesktop.hideMessageBox(IMessageBox); will be removed in version 6.1.
org.eclipse.scout.rt.client.ui.form.IForm.setAutoAddRemoveOnDesktop(boolean) use IForm.setShowOnStart(boolean); will be removed in version 6.1.
org.eclipse.scout.rt.client.ui.form.fields.AbstractValueField.setAutoDisplayText(boolean) no replacement. Will be removed in the O-Release.
org.eclipse.scout.rt.client.ui.wizard.AbstractWizardStep.setDescriptionHtml(String)
org.eclipse.scout.rt.client.ui.wizard.IWizardStep.setDescriptionHtml(String) Use setSubTitle() and/or setCssClass()
org.eclipse.scout.rt.client.ui.form.fields.AbstractFormField.setErrorStatus(IStatus)
org.eclipse.scout.rt.client.ui.form.fields.IFormField.setErrorStatus(IStatus) use IFormField.addErrorStatus(IStatus) or setErrorStatus(IMultiStatus status)
org.eclipse.scout.rt.client.ui.basic.cell.Cell.setErrorStatus(IStatus) use Cell.addErrorStatus(IStatus)
org.eclipse.scout.rt.client.ui.form.fields.AbstractFormField.setErrorStatus(String)
org.eclipse.scout.rt.client.ui.form.fields.IFormField.setErrorStatus(String)
org.eclipse.scout.rt.client.ui.basic.cell.Cell.setErrorStatus(String) use Cell.addErrorStatus(String)
org.eclipse.scout.rt.client.ui.desktop.IDesktop.setOutline(IOutline) use IDesktop.activateOutline(IOutline); will be removed in version 6.1.
org.eclipse.scout.rt.client.ui.basic.planner.AbstractPlanner.setSelectedResources(List<? extends Resource<RI>>) use AbstractPlanner.selectResources(List)
org.eclipse.scout.rt.client.ui.wizard.AbstractWizardStep.setTitleHtml(String)
org.eclipse.scout.rt.client.ui.wizard.IWizardStep.setTitleHtml(String) Use setTitle() and/or setCssClass()