Interface MdiEntry

All Superinterfaces:
UIPluginView
All Known Subinterfaces:
MdiEntrySWT
All Known Implementing Classes:
BaseMdiEntry, SideBarEntrySWT, TabbedEntry
public interface MdiEntry extends UIPluginView
A view (entry) that can be placed in a MDI (Multiple Document Interface). Successor to UISWTView, this class is not SWT specific. In fact, UISWTView and MdiEntry merge into a implementation class MdiEntrySWT later on: 
  UIPluginView
    + UISWTView
    |  + UISWTViewCore
    |     + MdiEntrySWT
    |     |  + BaseMdiEntry
    |     + UISWTViewImpl
    |        + BaseMdiEntry
    + MdiEntry
       + MdiEntrySWT
          + BaseMdiEntry
MdiEntry differ from UISWTView in that they contain MDI related properties, such as ViewTitleInfo, MdiEntryVitalityImage, expand state, parent entry, etc.

  • Method Details

    • getParentID

      String getParentID()
      ID of Parent MdiEntry

    • getDatasource

      Object getDatasource()
      Deprecated.
      use UIPluginView.getDataSource()

    • getExportableDatasource

      Object getExportableDatasource()
      Return an exportable version of the datasource. Usually String, but can be Map and List

    • isCloseable

      boolean isCloseable()

    • getId

      String getId()
      Deprecated.
      Use UIPluginView.getViewID()

    • addVitalityImage

      MdiEntryVitalityImage addVitalityImage(String imageID)

    • addListeners

      void addListeners(Object objectWithListeners)

    • addListener

      void addListener(MdiCloseListener l)
      Parameters:
      l -
      Since:
      4.1.0.3

    • addListener

      void addListener(MdiChildCloseListener l)

    • removeListener

      void removeListener(MdiCloseListener l)
      Parameters:
      l -
      Since:
      4.1.0.3

    • removeListener

      void removeListener(MdiChildCloseListener l)

    • addListener

      void addListener(MdiEntryOpenListener l)
      Parameters:
      l -
      Since:
      4.1.0.3

    • removeListener

      void removeListener(MdiEntryOpenListener l)
      Parameters:
      l -
      Since:
      4.1.0.3

    • addListener

      void addListener(MdiEntryDatasourceListener l)

    • removeListener

      void removeListener(MdiEntryDatasourceListener l)

    • setImageLeftID

      void setImageLeftID(String string)

    • addListener

      void addListener(MdiEntryDropListener listener)

    • removeListener

      void removeListener(MdiEntryDropListener listener)

    • addAcceleratorListener

      void addAcceleratorListener(MdiAcceleratorListener listener)

    • processAccelerator

      boolean processAccelerator(char c, int stateMask)

    • removeAcceleratorListener

      void removeAcceleratorListener(MdiAcceleratorListener listener)

    • setDatasource

      void setDatasource(Object ds)

    • isContentDisposed

      boolean isContentDisposed()
      Whether the content of this entry is disposed.

      Content can be disposed while entry is not disposed. Content is always disposed when entry is disposed.

    • isEntryDisposed

      boolean isEntryDisposed()
      Whether this entry is disposed.

      Content can be disposed while entry is not disposed. Content is always disposed when entry is disposed.

    • getViewTitleInfo

      ViewTitleInfo getViewTitleInfo()

    • setViewTitleInfo

      void setViewTitleInfo(ViewTitleInfo viewTitleInfo)

    • getMDI

      MultipleDocumentInterface getMDI()

    • getVitalityImages

      List<? extends MdiEntryVitalityImage> getVitalityImages()

    • close

      boolean close(boolean forceClose)
      Deprecated.
      use closeView()
      Closes this entry. Disposes this entry and its contents.
      Parameters:
      forceClose - Some views may cancel a close (upon user request). If true, the cancel attempts will be ignored, ensuring view will be closed.

    • closeView

      void closeView()
      Closes this entry. Disposes this entry and its contents. Removes entry from auto-open list.
      Specified by:
      closeView in interface UIPluginView

    • updateUI

      void updateUI(boolean force)

    • redraw

      void redraw()

    • hide

      void hide()

    • requestAttention

      void requestAttention()

    • getTitle

      String getTitle()

    • setTitle

      void setTitle(String title)

    • setTitleID

      void setTitleID(String titleID)

    • getImageLeftID

      String getImageLeftID()

    • isExpanded

      boolean isExpanded()

    • setExpanded

      void setExpanded(boolean expanded)

    • setDefaultExpanded

      void setDefaultExpanded(boolean defaultExpanded)

    • setParentEntryID

      void setParentEntryID(String parentEntryID)
      Set this entries belonging under another MdiEntry
      Parameters:
      parentEntryID - Parent Entry ID to place under (if MDI supports it)

    • getToolbarEnablers

      UIToolBarEnablerBase[] getToolbarEnablers()

    • addToolbarEnabler

      void addToolbarEnabler(UIToolBarEnablerBase enabler)

    • removeToolbarEnabler

      void removeToolbarEnabler(UIToolBarEnablerBase enabler)

    • isSelectable

      boolean isSelectable()

    • setSelectable

      void setSelectable(boolean selectable)

    • setPreferredAfterID

      void setPreferredAfterID(String preferredAfterID)

    • getPreferredAfterID

      String getPreferredAfterID()

    • setUserData

      void setUserData(Object key, Object value)

    • getUserData

      Object getUserData(Object key)

    • getAutoOpenInfo

      Map<String,Object> getAutoOpenInfo()