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 Detail

      • getParentID

        java.lang.String getParentID()
        ID of Parent MdiEntry
      • getExportableDatasource

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

        boolean isCloseable()
      • addListeners

        void addListeners​(java.lang.Object objectWithListeners)
      • addListener

        void addListener​(MdiCloseListener l)
        Parameters:
        l -
        Since:
        4.1.0.3
      • removeListener

        void removeListener​(MdiCloseListener l)
        Parameters:
        l -
        Since:
        4.1.0.3
      • setImageLeftID

        void setImageLeftID​(java.lang.String string)
      • setDatasource

        void setDatasource​(java.lang.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.

      • setViewTitleInfo

        void setViewTitleInfo​(ViewTitleInfo viewTitleInfo)
      • close

        boolean close​(boolean forceClose)
        Deprecated.
        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

        java.lang.String getTitle()
      • setTitle

        void setTitle​(java.lang.String title)
      • setTitleID

        void setTitleID​(java.lang.String titleID)
      • getImageLeftID

        java.lang.String getImageLeftID()
      • isExpanded

        boolean isExpanded()
      • setExpanded

        void setExpanded​(boolean expanded)
      • setDefaultExpanded

        void setDefaultExpanded​(boolean defaultExpanded)
      • setParentEntryID

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

        boolean isSelectable()
      • setSelectable

        void setSelectable​(boolean selectable)
      • setPreferredAfterID

        void setPreferredAfterID​(java.lang.String preferredAfterID)
      • getPreferredAfterID

        java.lang.String getPreferredAfterID()
      • setUserData

        void setUserData​(java.lang.Object key,
                         java.lang.Object value)
      • getUserData

        java.lang.Object getUserData​(java.lang.Object key)
      • getAutoOpenInfo

        java.util.Map<java.lang.String,​java.lang.Object> getAutoOpenInfo()