DecoratorPanel

Class Overview

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 }

Summary

[Expand] Inherited Constants
From class com.google.gwt.user.client.ui.UIObject String DEBUG_ID_PREFIX

[Expand] Inherited Methods
From class com.google.gwt.user.client.ui.SimplePanel void add(Widget w) Adds a widget to this panel. Element getContainerElement() Override this method to specify that an element other than the root element be the container for the panel's child widget. Widget getWidget() Gets the panel's child widget. Iterator<Widget> iterator() boolean remove(Widget w) Removes a child widget. void setWidget(IsWidget w) Set the only widget of the receiver, replacing the previous widget if there was one. void setWidget(Widget w) Sets this panel's widget.
From class com.google.gwt.user.client.ui.Panel void add(IsWidget child) void add(Widget child) Adds a child widget. final void adopt(Widget child) Finalize the attachment of a Widget to this Panel. void adopt(Widget w, Element container) This method is deprecated. Use adopt(Widget). void clear() Removes all child widgets. void disown(Widget w) This method is deprecated. Use orphan(Widget). void doAttachChildren() If a widget contains one or more child widgets that are not in the logical widget hierarchy (the child is physically connected only on the DOM level), it must override this method and call onAttach() for each of its child widgets. void doDetachChildren() If a widget contains one or more child widgets that are not in the logical widget hierarchy (the child is physically connected only on the DOM level), it must override this method and call onDetach() for each of its child widgets. final void orphan(Widget child) This method must be called as part of the remove method of any Panel. abstract boolean remove(Widget child) Removes a child widget. boolean remove(IsWidget child)
From class com.google.gwt.user.client.ui.Widget HandlerRegistration addAttachHandler(AttachEvent.Handler handler) Adds an AttachEvent handler. final <H extends EventHandler> HandlerRegistration addDomHandler(H handler, Type<H> type) Adds a native event handler to the widget and sinks the corresponding native event. final <H extends EventHandler> HandlerRegistration addHandler(H handler, Type<H> type) Adds this handler to the widget. Widget asWidget() Returns the Widget aspect of the receiver. static Widget asWidgetOrNull(IsWidget w) This convenience method makes a null-safe call to asWidget(). HandlerManager createHandlerManager() Creates the HandlerManager used by this Widget. void delegateEvent(Widget target, GwtEvent<?> event) Fires an event on a child widget. void doAttachChildren() If a widget contains one or more child widgets that are not in the logical widget hierarchy (the child is physically connected only on the DOM level), it must override this method and call onAttach() for each of its child widgets. void doDetachChildren() If a widget contains one or more child widgets that are not in the logical widget hierarchy (the child is physically connected only on the DOM level), it must override this method and call onDetach() for each of its child widgets. void fireEvent(GwtEvent<?> event) Fires the given event to the handlers listening to the event's type. int getHandlerCount(Type<?> type) Gets the number of handlers listening to the event type. Object getLayoutData() Gets the panel-defined layout data associated with this widget. Widget getParent() Gets this widget's parent panel. boolean isAttached() Determines whether this widget is currently attached to the browser's document (i.e., there is an unbroken chain of widgets between this widget and the underlying browser document). final boolean isOrWasAttached() Has this widget ever been attached? void onAttach() This method is called when a widget is attached to the browser's document. void onBrowserEvent(Event event) Fired whenever a browser event is received. void onDetach() This method is called when a widget is detached from the browser's document. void onLoad() This method is called immediately after a widget becomes attached to the browser's document. void onUnload() This method is called immediately before a widget will be detached from the browser's document. void removeFromParent() Removes this widget from its parent widget, if one exists. void setLayoutData(Object layoutData) Sets the panel-defined layout data associated with this widget. void sinkEvents(int eventBitsToAdd) Overridden to defer the call to super.sinkEvents until the first time this widget is attached to the dom, as a performance enhancement.
From class com.google.gwt.user.client.ui.UIObject void addStyleDependentName(String styleSuffix) Adds a dependent style name by specifying the style name's suffix. void addStyleName(String style) Adds a secondary or dependent style name to this object. static void ensureDebugId(Element elem, String baseID, String id) Set the debug id of a specific element. final void ensureDebugId(String id) Ensure that the main Element for this UIObject has an ID property set, which allows it to integrate with third-party libraries and test tools. static void ensureDebugId(Element elem, String id) Ensure that elem has an ID property set, which allows it to integrate with third-party libraries and test tools. int getAbsoluteLeft() Gets the object's absolute left position in pixels, as measured from the browser window's client area. int getAbsoluteTop() Gets the object's absolute top position in pixels, as measured from the browser window's client area. Element getElement() Gets a handle to the object's underlying DOM element. int getOffsetHeight() Gets the object's offset height in pixels. int getOffsetWidth() Gets the object's offset width in pixels. Element getStyleElement() Template method that returns the element to which style names will be applied. String getStyleName() Gets all of the object's style names, as a space-separated list. static String getStyleName(Element elem) Gets all of the element's style names, as a space-separated list. String getStylePrimaryName() Gets the primary style name associated with the object. static String getStylePrimaryName(Element elem) Gets the element's primary style name. String getTitle() Gets the title associated with this object. boolean isVisible() Determines whether or not this object is visible. static boolean isVisible(Element elem) void onEnsureDebugId(String baseID) Called when the user sets the id using the ensureDebugId(String) method. void removeStyleDependentName(String styleSuffix) Removes a dependent style name by specifying the style name's suffix. void removeStyleName(String style) Removes a style name. final void setElement(Element elem) Sets this object's browser element. void setElement(Element elem) Sets this object's browser element. void setHeight(String height) Sets the object's height. void setPixelSize(int width, int height) Sets the object's size, in pixels, not including decorations such as border, margin, and padding. void setSize(String width, String height) Sets the object's size. void setStyleDependentName(String styleSuffix, boolean add) Adds or removes a dependent style name by specifying the style name's suffix. static void setStyleName(Element elem, String styleName) Clears all of the element's style names and sets it to the given style. static void setStyleName(Element elem, String style, boolean add) This convenience method adds or removes a style name for a given element. void setStyleName(String style) Clears all of the object's style names and sets it to the given style. void setStyleName(String style, boolean add) Adds or removes a style name. void setStylePrimaryName(String style) Sets the object's primary style name and updates all dependent style names. static void setStylePrimaryName(Element elem, String style) Sets the element's primary style name and updates all dependent style names. void setTitle(String title) Sets the title associated with this object. void setVisible(boolean visible) Sets whether this object is visible. static void setVisible(Element elem, boolean visible) void setWidth(String width) Sets the object's width. void sinkEvents(int eventBitsToAdd) Adds a set of events to be sunk by this object. String toString() This method is overridden so that any object can be viewed in the debugger as an HTML snippet. void unsinkEvents(int eventBitsToRemove) Removes a set of events from this object's event list.
From class java.lang.Object Object clone() boolean equals(Object arg0) void finalize() final Class<?> getClass() int hashCode() final void notify() final void notifyAll() String toString() final void wait() final void wait(long arg0, int arg1) final void wait(long arg0)
From interface com.google.gwt.event.logical.shared.HasAttachHandlers abstract HandlerRegistration addAttachHandler(AttachEvent.Handler handler) Adds an AttachEvent handler.
From interface com.google.gwt.event.shared.HasHandlers abstract void fireEvent(GwtEvent<?> event) Fires the given event to the handlers listening to the event's type.
From interface com.google.gwt.user.client.EventListener abstract void onBrowserEvent(Event event) Fired whenever a browser event is received.
From interface com.google.gwt.user.client.ui.AcceptsOneWidget abstract void setWidget(IsWidget w) Set the only widget of the receiver, replacing the previous widget if there was one.
From interface com.google.gwt.user.client.ui.HasOneWidget abstract Widget getWidget() Gets the panel's child widget. abstract void setWidget(Widget w) Sets this panel's widget.
From interface com.google.gwt.user.client.ui.HasWidgets abstract void add(Widget w) Adds a child widget. abstract void clear() Removes all child widgets. abstract Iterator<Widget> iterator() Gets an iterator for the contained widgets. abstract boolean remove(Widget w) Removes a child widget.
From interface com.google.gwt.user.client.ui.HasWidgets.ForIsWidget abstract void add(IsWidget w) abstract boolean remove(IsWidget w)
From interface com.google.gwt.user.client.ui.IsWidget abstract Widget asWidget() Returns the Widget aspect of the receiver.
From interface java.lang.Iterable abstract Iterator<T> iterator()