Package docking

Class ComponentPlaceholder


  • public class ComponentPlaceholder
    extends java.lang.Object
    Class to hold information about a dockable component with respect to its position within the windowing system. It also holds identification information about the provider so that its location can be reused when the provider is re-opened.
    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      DockableComponent getComponent()
      Returns a Dockable component that wraps the component for this placeholder
      java.lang.String getFullTitle()
      Returns the full title for this component (title + subtitle)
      java.lang.String getName()
      Returns the name of this component.
      ComponentProvider getProvider()
      Returns the component provider for this placeholder.
      java.lang.String getSubTitle()
      Returns the subtitle for the component
      java.lang.String getTabText()
      The text for display on the tab of a tabbed component.
      java.lang.String getTitle()
      Returns the title for this component
      boolean isDisposed()  
      java.lang.String toString()  
      void update()  
      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
    • Method Detail

      • isDisposed

        public boolean isDisposed()
      • getComponent

        public DockableComponent getComponent()
        Returns a Dockable component that wraps the component for this placeholder
        Returns:
        the component
      • getTitle

        public java.lang.String getTitle()
        Returns the title for this component
        Returns:
        the title for this component
      • getSubTitle

        public java.lang.String getSubTitle()
        Returns the subtitle for the component
        Returns:
        the subtitle for the component
      • getTabText

        public java.lang.String getTabText()
        The text for display on the tab of a tabbed component.
        Returns:
        The text for display on the tab of a tabbed component.
      • getName

        public java.lang.String getName()
        Returns the name of this component.
        Returns:
        the name of this component.
      • update

        public void update()
      • getProvider

        public ComponentProvider getProvider()
        Returns the component provider for this placeholder.
        Returns:
        the component provider for this placeholder.
      • getFullTitle

        public java.lang.String getFullTitle()
        Returns the full title for this component (title + subtitle)
        Returns:
        the full title for this component (title + subtitle)
      • toString

        public java.lang.String toString()
        Overrides:
        toString in class java.lang.Object