blob: 1124c03ade28185862e62b0bc3895c27c8b9d1f1 (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
|
/*
* Copyright 2011 Vaadin Ltd.
*
* Licensed under the Apache License, Version 2.0 (the "License"); you may not
* use this file except in compliance with the License. You may obtain a copy of
* the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
* WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
* License for the specific language governing permissions and limitations under
* the License.
*/
package com.vaadin.client.ui;
import com.google.gwt.user.client.Element;
import com.google.gwt.user.client.ui.Widget;
import com.vaadin.client.ComponentLocator;
/**
* Interface implemented by {@link Widget}s which can provide identifiers for at
* least one element inside the component. Used by {@link ComponentLocator}.
*
*/
public interface SubPartAware {
/**
* Locates an element inside a component using the identifier provided in
* {@code subPart}. The {@code subPart} identifier is component specific and
* may be any string of characters, numbers, space characters and brackets.
*
* @param subPart
* The identifier for the element inside the component
* @return The element identified by subPart or null if the element could
* not be found.
*/
Element getSubPartElement(String subPart);
/**
* Provides an identifier that identifies the element within the component.
* The {@code subElement} is a part of the component and must never be null.
* <p>
* <b>Note!</b>
* {@code getSubPartElement(getSubPartName(element)) == element} is <i>not
* always</i> true. A component can choose to provide a more generic
* identifier for any given element if the results of all interactions with
* {@code subElement} 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 as {@code subElement} because interactions with the DIV and the
* root button element produce the same result.
*
* @param subElement
* The element the identifier string should uniquely identify
* @return An identifier that uniquely identifies {@code subElement} or null
* if no identifier could be provided.
*/
String getSubPartName(Element subElement);
}
|
