Package com.google.gwt.user.client.ui

Class DecoratorPanel

java.lang.Object
com.google.gwt.user.client.ui.UIObject
com.google.gwt.user.client.ui.Widget
com.google.gwt.user.client.ui.Panel
com.google.gwt.user.client.ui.SimplePanel
com.google.gwt.user.client.ui.DecoratorPanel
All Implemented Interfaces:
HasAttachHandlers, HasHandlers, EventListener, AcceptsOneWidget, HasOneWidget, HasVisibility, HasWidgets, HasWidgets.ForIsWidget, IsWidget, Iterable<Widget>
public class DecoratorPanel extends SimplePanel

A SimplePanel that wraps its contents in stylized boxes, which can be used to add rounded corners to a Widget.

This widget will only work in quirks mode in most cases. Specifically, setting the height or width of the DecoratorPanel will result in rendering issues.

Wrapping a Widget in a "9-box" allows users to specify images in each of the corners and along the four borders. This method allows the content within the DecoratorPanel to resize without disrupting the look of the border. In addition, rounded corners can generally be combined into a single image file, which reduces the number of downloaded files at startup. This class also simplifies the process of using AlphaImageLoaders to support 8-bit transparencies (anti-aliasing and shadows) in ie6, which does not support them normally.

Setting the Size:

If you set the width or height of the DecoratorPanel, you need to set the height and width of the middleCenter cell to 100% so that the middleCenter cell takes up all of the available space. If you do not set the width and height of the DecoratorPanel, it will wrap its contents tightly. 

 .gwt-DecoratorPanel .middleCenter {
   height: 100%;
   width: 100%;
 }

CSS Style Rules

  • .gwt-DecoratorPanel { the panel }
  • .gwt-DecoratorPanel .top { the top row }
  • .gwt-DecoratorPanel .topLeft { the top left cell }
  • .gwt-DecoratorPanel .topLeftInner { the inner element of the cell }
  • .gwt-DecoratorPanel .topCenter { the top center cell }
  • .gwt-DecoratorPanel .topCenterInner { the inner element of the cell }
  • .gwt-DecoratorPanel .topRight { the top right cell }
  • .gwt-DecoratorPanel .topRightInner { the inner element of the cell }
  • .gwt-DecoratorPanel .middle { the middle row }
  • .gwt-DecoratorPanel .middleLeft { the middle left cell }
  • .gwt-DecoratorPanel .middleLeftInner { the inner element of the cell }
  • .gwt-DecoratorPanel .middleCenter { the middle center cell }
  • .gwt-DecoratorPanel .middleCenterInner { the inner element of the cell }
  • .gwt-DecoratorPanel .middleRight { the middle right cell }
  • .gwt-DecoratorPanel .middleRightInner { the inner element of the cell }
  • .gwt-DecoratorPanel .bottom { the bottom row }
  • .gwt-DecoratorPanel .bottomLeft { the bottom left cell }
  • .gwt-DecoratorPanel .bottomLeftInner { the inner element of the cell }
  • .gwt-DecoratorPanel .bottomCenter { the bottom center cell }
  • .gwt-DecoratorPanel .bottomCenterInner { the inner element of the cell }
  • .gwt-DecoratorPanel .bottomRight { the bottom right cell }
  • .gwt-DecoratorPanel .bottomRightInner { the inner element of the cell }

  • Constructor Details

    • DecoratorPanel

      public DecoratorPanel()
      Create a new DecoratorPanel.

    • DecoratorPanel

      DecoratorPanel(String[] rowStyles, int containerIndex)
      Creates a new panel using the specified style names to apply to each row. Each row will contain three cells (Left, Center, and Right). The Center cell in the containerIndex row will contain the Widget.
      Parameters:
      rowStyles - an array of style names to apply to each row
      containerIndex - the index of the container row

  • Method Details

    • createTR

      static Element createTR(String styleName)
      Create a new row with a specific style name. The row will contain three cells (Left, Center, and Right), each prefixed with the specified style name. This method allows Widgets to reuse the code on a DOM level, without creating a DecoratorPanel Widget.
      Parameters:
      styleName - the style name
      Returns:
      the new row Element

    • getCellElement

      protected Element getCellElement(int row, int cell)
      Get a specific Element from the panel.
      Parameters:
      row - the row index
      cell - the cell index
      Returns:
      the Element at the given row and cell

    • getContainerElement

      protected Element getContainerElement()
      Description copied from class: SimplePanel
      Override this method to specify that an element other than the root element be the container for the panel's child widget. This can be useful when you want to create a simple panel that decorates its contents. Note that this method continues to return the Element class defined in the User module to maintain backwards compatibility.
      Overrides:
      getContainerElement in class SimplePanel
      Returns:
      the element to be used as the panel's container