com.vaadin.flow.component.icon.FontIcon Maven / Gradle / Ivy
/*
* Copyright 2000-2024 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.flow.component.icon;
import java.util.Optional;
import com.vaadin.flow.dom.ElementConstants;
/**
* Component for displaying an icon from a font icon collection. Note that the
* icon font must be loaded separately. One way to do this is by including it in
* the application's theme.
*
* @author Vaadin Ltd
*/
public class FontIcon extends AbstractIcon {
/**
* Default constructor. Creates an empty font icon.
*/
public FontIcon() {
}
/**
* Creates a font icon component with the given icon class names.
*
* Example: new FontIcon("fa-solid", "fa-user").
*
* @param iconClassNames
* The icon class names, not null
* @see #setIconClassNames(String...)
*/
public FontIcon(String... iconClassNames) {
setIconClassNames(iconClassNames);
}
/**
* Sets the icon class names defining an icon font and/or a specific glyph
* inside an icon font.
*
* Example: setIconClassNames("fa-solid", "fa-user").
*
* @param iconClassNames
* The icon class names, not null
*/
public void setIconClassNames(String... iconClassNames) {
getElement().setProperty("iconClass", iconClassNames.length == 0 ? null
: String.join(" ", iconClassNames));
}
/**
* Gets the icon class names defining an icon font and/or a specific glyph
* inside an icon font.
*
* @return The icon class names
*/
public String[] getIconClassNames() {
return Optional.ofNullable(getElement().getProperty("iconClass"))
.map(f -> f.split(" ")).orElse(new String[0]);
}
/**
* Sets the font family to use for the font icon.
*
* @param fontFamily
* the font family to use
*/
public void setFontFamily(String fontFamily) {
getElement().setProperty("fontFamily", fontFamily);
}
/**
* Gets the font family to use for the font icon.
*
* @return the font family to use
*/
public String getFontFamily() {
return getElement().getProperty("fontFamily");
}
/**
* Sets the hexadecimal code point that specifies a glyph from an icon font.
*
* Example: setCharCode("e001")
*
* @param charCode
* the character code to use
*/
public void setCharCode(String charCode) {
getElement().setProperty("char", charCode);
}
/**
* Gets the hexadecimal code point that specifies a glyph from an icon font.
*
* @return the character code to use
*/
public String getCharCode() {
return getElement().getProperty("char");
}
/**
* Sets the ligature name that specifies an icon from an icon font with
* support for ligatures.
*
* Example: setLigature("home")
*
* @param ligature
* the ligature to use
*/
public void setLigature(String ligature) {
getElement().setProperty("ligature", ligature);
}
/**
* Gets the ligature name that specifies an icon from an icon font with
* support for ligatures.
*
* @return the ligature to use
*/
public String getLigature() {
return getElement().getProperty("ligature");
}
@Override
public void setColor(String color) {
getStyle().set(ElementConstants.STYLE_COLOR, color);
}
@Override
public String getColor() {
return getStyle().get(ElementConstants.STYLE_COLOR);
}
}