Documentation of 'kcl.waterloo.swing.GCGridContainerInterface' Java class
GCGridContainerInterface
kcl.waterloo.swing

Interface GCGridContainerInterface

  • All Known Implementing Classes:
    GCGridContainer, GCTabbedGridContainer


    public interface GCGridContainerInterface
    An interface to define common behaviour for implementing classes intended to contain GCGrid instances.
    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method and Description
      java.awt.Component add(java.awt.Component c, double row, double column)
      Adds a component to the contained grid.
      java.awt.Component add(java.awt.Component c, double row, double column, double width, double height)
      Adds a component to the contained grid.
      java.awt.Component add(java.awt.Component c, double row, double column, double width, double height, int tab) 
      java.awt.Component getComponentAt(int tab)
      Returns the component at the specified tab location.
      GCInfoBar getInfoBar()
      Returns the presently selected GCInfoBar for the selected container if it is a GCGridContainer.
      java.awt.Container getSelected()
      Returns the presently selected item.
    • Method Detail

      • getSelected

        java.awt.Container getSelected()
        Returns the presently selected item. For a GCGridContainer instance this returns the instance. For a GCTabbedGridContainer, it returns the selected component which may or may not be a GCGridContainer.
        Returns:
        the Container
      • getInfoBar

        GCInfoBar getInfoBar()
                      throws java.lang.UnsupportedOperationException
        Returns the presently selected GCInfoBar for the selected container if it is a GCGridContainer. Throws UnsupportedOperationException otherwise.
        Returns:
        the GCInfoBar
        Throws:
        java.lang.UnsupportedOperationException
      • add

        java.awt.Component add(java.awt.Component c,
                               double row,
                               double column)
        Adds a component to the contained grid. Throws UnsupportedOperationException if the target is not a GCGridContainerInterface.
        Parameters:
        c - - the added component, which will normally be wrapped in a GCGridElement instance.
        row -
        column -
        Returns:
        the added component
      • add

        java.awt.Component add(java.awt.Component c,
                               double row,
                               double column,
                               double width,
                               double height)
        Adds a component to the contained grid. Throws UnsupportedOperationException if the target is not a GCGridContainerInterface.
        Parameters:
        c - - the added component, which will normally be wrapped in a GCGridElement instance.
        row -
        column -
        width -
        height -
        Returns:
        the added component
      • add

        java.awt.Component add(java.awt.Component c,
                               double row,
                               double column,
                               double width,
                               double height,
                               int tab)
                        throws java.lang.UnsupportedOperationException
        Throws:
        java.lang.UnsupportedOperationException
      • getComponentAt

        java.awt.Component getComponentAt(int tab)
        Returns the component at the specified tab location.
        Parameters:
        tab -
        Returns:
        a Component

DMelt 3.0 © DataMelt by jWork.ORG

You see the box below because you did not login.