com.gwtplatform.idhandler.client.HasElementId Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of cedar-common-gwt Show documentation

Utility code for use with GWT and Mvp4g.

There is a newer version: 5.8.4

/**
 * Copyright 2011 ArcBees Inc.
 *
 * 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.gwtplatform.idhandler.client;

/**
 * Interface typically implemented by custom UI objects that provides an abstract way of setting DOM element IDs.
 *
 * Code Source
 *
 * 
 * This is external code that was copied into the CedarCommon codebase under
 * the terms of its license.
 * 
 *
 * 
 *    
 *       
 *          
 *             
 *             
 *          
 *          
 *             
 *             
 *          
 *       
 *    Source: GWTP Issue #389
Date: March, 2011
 * 
 *
 * @see WithElementId
 */
public interface HasElementId {

    /**
     * Applies the given DOM element ID to this object.
     *
     * @param elementId
     *            Element ID to set.
     */
    void setElementId(String elementId);

    /** Gets the DOM element ID that has been applied to this object. */
    String getElementId();

}