1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768 |
- /*
- * Copyright 2000-2014 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.server;
-
- import com.vaadin.shared.ui.label.ContentMode;
- import com.vaadin.ui.Label;
-
- /**
- * A font icon is a type of icon that is made by displaying one character from a
- * specially constructed font containing icons ("icon font").
- * <p>
- * {@link FontIcon} is a custom resource type which uses the URI scheme
- * <code>fonticon://<fontfamily>/<codepoint></code> to reference a
- * specific icon from a specific icon font. <br/>
- * </p>
- *
- * @since 7.2
- * @author Vaadin Ltd
- */
- public interface FontIcon extends Resource {
- /**
- * Returns the name (font family) of the font from which this icon comes.
- * The name is used to apply the correct font where the icon is used.
- *
- * @since 7.2
- * @return
- */
- public String getFontFamily();
-
- /**
- * Returns the unicode codepoint (character location) for this icon within
- * the font given in {@link #getFontFamily()}.
- * <p>
- * For example, 0x0021 would in a regular font be the codepoint for the
- * exclamation-point character.<br/>
- * When constructing icon fonts, it might be a good idea to use the
- * codepoints in the "Private use area", from 0xE000 0xF8FF.
- * </p>
- *
- * @since 7.2
- * @return
- */
- public int getCodepoint();
-
- /**
- * Returns HTML that can be used to display the icon in places where HTML
- * can be used, such as a {@link Label} with {@link ContentMode#HTML}.
- *
- *
- * @since 7.2
- * @return HTML needed to display icon
- */
- public String getHtml();
- }
|