com.vaadin.client.ui.
Interface SubPartAware
-
All Known Implementing Classes:
Escalator, Grid, TreeGrid, VAbstractCalendarPanel, VAbstractPopupCalendar, VAbstractTextualDate, VColorPickerGradient, VComboBox, VComboBox.SuggestionMenu, VContextMenu, VDateCalendarPanel, VDateTimeCalendarPanel, VMenuBar, VMenuBar.CustomMenuItem, VPopupCalendar, VPopupTimeCalendar, VSlider, VTabsheet, VTwinColSelect
public interface SubPartAware
Interface implemented by
Widget
s which can provide identifiers for at least one element inside the component.
-
-
Method Summary
All Methods Modifier and Type Method and Description com.google.gwt.user.client.Element
getSubPartElement(String subPart)
Locates an element inside a component using the identifier provided in
subPart
.String
getSubPartName(com.google.gwt.user.client.Element subElement)
Provides an identifier that identifies the element within the component.
-
-
-
Method Detail
-
getSubPartElement
com.google.gwt.user.client.Element getSubPartElement(String subPart)
Locates an element inside a component using the identifier provided in
subPart
. ThesubPart
identifier is component specific and may be any string of characters, numbers, space characters and brackets.Parameters:
subPart
- The identifier for the element inside the componentReturns:
The element identified by subPart or null if the element could not be found.
-
getSubPartName
String getSubPartName(com.google.gwt.user.client.Element subElement)
Provides an identifier that identifies the element within the component. The
subElement
is a part of the component and must never be null.Note!
getSubPartElement(getSubPartName(element)) == element
is not always true. A component can choose to provide a more generic identifier for any given element if the results of all interactions withsubElement
are the same as interactions with the element identified by the return value. For example a button can return an identifier for the root element even though a DIV inside the button was passed assubElement
because interactions with the DIV and the root button element produce the same result.Parameters:
subElement
- The element the identifier string should uniquely identifyReturns:
An identifier that uniquely identifies
subElement
or null if no identifier could be provided.
-
-