Grid

Class Overview

A rectangular grid that can contain text, html, or a child Widget within its cells. It must be resized explicitly to the desired number of rows and columns.

Example

Use in UiBinder Templates

Grid widget consists of <g:row> elements. Each <g:row> element can contain one or more <g:cell> or <g:customCell> elements. Using <g:cell> attribute it is possible to place pure HTML content. <g:customCell> is used as a container for Widget type objects. (Note that the tags of the row, cell and customCell elements are not capitalized. This is meant to signal that the item is not a runtime object, and so cannot have a ui:field attribute.)

For example:

 <g:Grid>
  <g:row>
    <g:customCell>
      <g:Label>foo</g:Label>
    </g:customCell>
    <g:customCell>
      <g:Label>bar</g:Label>
    </g:customCell>
  </g:row>
  <g:row>
    <g:cell>
      <div>foo</div>
    </g:cell>
    <g:cell>
      <div>bar</div>
    </g:cell>
  </g:row>
 </g:Grid>
 

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.HTMLTable HandlerRegistration addClickHandler(ClickHandler handler) Adds a ClickEvent handler. HandlerRegistration addDoubleClickHandler(DoubleClickHandler handler) Adds a DoubleClickEvent handler. void addTableListener(TableListener listener) This method is deprecated. add a click handler instead and use getCellForEvent(ClickEvent) to get the cell information (remember to check for a null return value) void checkCellBounds(int row, int column) Bounds checks that the cell exists at the specified location. void checkRowBounds(int row) Checks that the row is within the correct bounds. void clear() Removes all widgets from this table, but does not remove other HTML or text contents of cells. void clear(boolean clearInnerHTML) Removes all widgets from this table, optionally clearing the inner HTML of each cell. boolean clearCell(int row, int column) Clears the cell at the given row and column. Element createCell() Creates a new cell. Element getBodyElement() Gets the table's TBODY element. abstract int getCellCount(int row) Gets the number of cells in a given row. HTMLTable.Cell getCellForEvent(ClickEvent event) Given a click event, return the Cell that was clicked, or null if the event did not hit this table. HTMLTable.CellFormatter getCellFormatter() Gets the HTMLTable.CellFormatter associated with this table. int getCellPadding() Gets the amount of padding that is added around all cells. int getCellSpacing() Gets the amount of spacing that is added around all cells. HTMLTable.ColumnFormatter getColumnFormatter() Gets the column formatter. int getDOMCellCount(int row) Directly ask the underlying DOM what the cell count on the given row is. int getDOMCellCount(Element tableBody, int row) Directly ask the underlying DOM what the cell count on the given row is. int getDOMRowCount(Element elem) int getDOMRowCount() Directly ask the underlying DOM what the row count is. Element getEventTargetCell(Event event) Determines the TD associated with the specified event. String getHTML(int row, int column) Gets the HTML contents of the specified cell. abstract int getRowCount() Gets the number of rows present in this table. HTMLTable.RowFormatter getRowFormatter() Gets the RowFormatter associated with this table. String getText(int row, int column) Gets the text within the specified cell. Widget getWidget(int row, int column) Gets the widget in the specified cell. void insertCell(int row, int column) Inserts a new cell into the specified row. void insertCells(int row, int column, int count) Inserts a number of cells before the specified cell. int insertRow(int beforeRow) Inserts a new row into the table. boolean internalClearCell(Element td, boolean clearInnerHTML) Does actual clearing, used by clearCell and cleanCell. boolean isCellPresent(int row, int column) Determines whether the specified cell exists. Iterator<Widget> iterator() Returns an iterator containing all the widgets in this table. void onEnsureDebugId(String baseID) Affected Elements: -(row)#-(cell)# = the cell at the given row and cell index. abstract void prepareCell(int row, int column) Subclasses must implement this method. void prepareColumn(int column) Subclasses can implement this method. abstract void prepareRow(int row) Subclasses must implement this method. boolean remove(Widget widget) Remove the specified widget from the table. void removeCell(int row, int column) Removes the specified cell from the table. void removeRow(int row) Removes the specified row from the table. void removeTableListener(TableListener listener) This method is deprecated. Use the removeHandler() method on the object returned by an add*Handler method instead void setBorderWidth(int width) Sets the width of the table's border. void setCellFormatter(HTMLTable.CellFormatter cellFormatter) Sets the table's CellFormatter. void setCellPadding(int padding) Sets the amount of padding to be added around all cells. void setCellSpacing(int spacing) Sets the amount of spacing to be added around all cells. void setColumnFormatter(HTMLTable.ColumnFormatter formatter) void setHTML(int row, int column, SafeHtml html) Sets the HTML contents of the specified cell. void setHTML(int row, int column, String html) Sets the HTML contents of the specified cell. void setRowFormatter(HTMLTable.RowFormatter rowFormatter) Sets the table's RowFormatter. void setText(int row, int column, String text) Sets the text within the specified cell. void setWidget(int row, int column, Widget widget) Sets the widget within the specified cell.
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.dom.client.HasClickHandlers abstract HandlerRegistration addClickHandler(ClickHandler handler) Adds a ClickEvent handler.
From interface com.google.gwt.event.dom.client.HasDoubleClickHandlers abstract HandlerRegistration addDoubleClickHandler(DoubleClickHandler handler) Adds a DoubleClickEvent handler.
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.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 com.google.gwt.user.client.ui.SourcesTableEvents abstract void addTableListener(TableListener listener) This method is deprecated. See the interface doc instead abstract void removeTableListener(TableListener listener) This method is deprecated. Use the removeHandler() method on the object returned by an add*Handler method instead
From interface java.lang.Iterable abstract Iterator<T> iterator()