com.google.gwt.user.client.ui.PasswordTextBox Maven / Gradle / Ivy
/*
* Copyright 2007 Google 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.google.gwt.user.client.ui;
import com.google.gwt.dom.client.Document;
import com.google.gwt.dom.client.Element;
import com.google.gwt.dom.client.InputElement;
/**
* A text box that visually masks its input to prevent eavesdropping.
*
*
* 
*
*
* CSS Style Rules
*
* - .gwt-PasswordTextBox { primary style }
* - .gwt-PasswordTextBox-readonly { dependent style set when the password
* text box is read-only }
*
*
*
*
Example
* {@example com.google.gwt.examples.TextBoxExample}
*
*/
public class PasswordTextBox extends TextBox {
/**
* Creates a PasswordTextBox widget that wraps an existing <input
* type='password'> element.
*
* This element must already be attached to the document. If the element is
* removed from the document, you must call
* {@link RootPanel#detachNow(Widget)}.
*
* @param element the element to be wrapped
*/
public static PasswordTextBox wrap(Element element) {
// Assert that the element is attached.
assert Document.get().getBody().isOrHasChild(element);
PasswordTextBox textBox = new PasswordTextBox(element);
// Mark it attached and remember it for cleanup.
textBox.onAttach();
RootPanel.detachOnWindowClose(textBox);
return textBox;
}
/**
* Creates an empty password text box.
*/
public PasswordTextBox() {
super(Document.get().createPasswordInputElement(), "gwt-PasswordTextBox");
}
/**
* This constructor may be used by subclasses to explicitly use an existing
* element. This element must be an <input> element whose type is
* 'password'.
*
* @param element the element to be used
*/
protected PasswordTextBox(Element element) {
super(element, null);
assert InputElement.as(element).getType().equalsIgnoreCase("password");
}
}