How to use

HippoIcon

in

org.hippoecm.frontend.plugins.standards.icon

@Override
protected Component getIcon(final String id) {
  return HippoIcon.fromSprite(id, Icon.PENCIL_SQUARE);
}

@Override
protected Component getIcon(final String id) {
  return HippoIcon.inline(id, CmsIcon.FLOPPY_TIMES_CIRCLE);
}

public static HippoIcon getIconForNodeType(final String id, final NodeType type, final Icon defaultIcon, final IconSize size) {
  final String nodeTypeIconName = StringUtils.replace(type.getName(), ":", "-");
  final ResourceReference reference = BrowserStyle.getIconOrNull(nodeTypeIconName, size);
  if (reference != null) {
    final HippoIcon icon = HippoIcon.fromResource(id, reference, size);
    icon.addCssClass("hi");
    icon.addCssClass("hi-custom-node-type");
    icon.addCssClass("hi-" + size.name().toLowerCase());
    return icon;
  }
  return HippoIcon.fromSprite(id, defaultIcon, size);
}

public HippoIcon replaceFromResource(final HippoIcon oldIcon, final ResourceReference newReference,
                   final Position position) {
  HippoIcon newCopy = HippoIcon.fromResource(oldIcon.getId(), newReference);
  addIcon(newCopy, position);
  return newCopy;
}

public HippoIcon replaceFromSprite(final HippoIcon oldIcon, final Icon newIcon, final Position position) {
  HippoIcon newCopy = HippoIcon.fromSprite(oldIcon.getId(), newIcon);
  addIcon(newCopy, position);
  return newCopy;
}

public HippoIcon replaceInline(final HippoIcon oldIcon, final CmsIcon newIcon, final Position position) {
  HippoIcon newCopy = HippoIcon.inline(oldIcon.getId(), newIcon);
  addIcon(newCopy, position);
  return newCopy;
}

private Component getDocumentIcon(final Node node, final String id, final IconSize size) throws RepositoryException {
  if (localeProvider != null) {
    if (node.isNodeType(HippoTranslationNodeType.NT_TRANSLATED)) {
      String localeName = node.getProperty(HippoTranslationNodeType.LOCALE).getString();
      for (HippoLocale locale : localeProvider.getLocales()) {
        if (localeName.equals(locale.getName())) {
          ResourceReference reference = locale.getIcon(size, LocaleState.EXISTS);
          return HippoIcon.fromResource(id, reference);
        }
      }
      log.info("Locale '{}' was not found in locale provider", localeName);
    }
  }
  return HippoIcon.fromSprite(id, Icon.FILE_TEXT);
}

  public BreadCrumbComponent(String id, long index, IBreadCrumbModel breadCrumbModel,
      final IBreadCrumbParticipant participant, boolean enableLink) {
    super(id);
    HippoIcon icon = HippoIcon.fromSprite("sep", Icon.CHEVRON_RIGHT);
    icon.addCssClass("breadcrumbs-separator");
    icon.setVisible(enableLink);
    add(icon);
    BreadCrumbLink link = new AjaxBreadCrumbLink("link", breadCrumbModel) {
      private static final long serialVersionUID = 1L;
      protected IBreadCrumbParticipant getParticipant(String componentId) {
        return participant;
      }
    };
    link.setEnabled(enableLink);
    add(link);
    IModel<String> title;
    if (participant instanceof IPanelPluginParticipant) {
      title = ((IPanelPluginParticipant) participant).getTitle(this);
    } else {
      title = participant.getTitle();
    }
    link.add(new Label("label", title).setRenderBodyOnly(true));
  }
}

  @Override
  protected void initialize() {
    add(CssClass.append(new AbstractReadOnlyModel<String>() {
      @Override
      public String getObject() {
        return StdWorkflow.this.isEnabled() ? "icon-enabled" : "icon-disabled";
      }
    }));
    Component icon = getIcon(ICON_ID);
    if (icon == null) {
      if (getIcon() != null) {
        // Legacy custom override
        icon = HippoIcon.fromResourceModel(ICON_ID, new LoadableDetachableModel<ResourceReference>() {
          @Override
          protected ResourceReference load() {
            return getIcon();
          }
        });
      } else {
        icon = HippoIcon.fromSprite(ICON_ID, Icon.GEAR);
      }
    }
    add(icon);
  }
});

/**
 * Renders an icon stored in a resource. When the icon's file extension is '.svg',
 * the icon is rendered as an inline SVG image.
 * @param id the Wicket id of the icon
 * @param reference the resource to render
 * @return the icon component
 */
public static HippoIcon fromResource(final String id, final ResourceReference reference) {
  return fromResource(id, reference, -1, -1);
}

public HippoIcon replaceCopyOf(final HippoIcon oldIcon, final HippoIcon newIcon,
                final Position position) {
  HippoIcon newCopy = HippoIcon.copy(newIcon, oldIcon.getId());
  addIcon(newCopy, position);
  return newCopy;
}

  private void addPosition(final HippoIcon icon, final Position position) {
    if (position != null) {
      icon.addCssClass("hi-" + position.vertical);
      icon.addCssClass("hi-" + position.horizontal);
    }
  }
}

public HippoIcon addCopyOf(final HippoIcon icon, final Position position) {
  HippoIcon copy = HippoIcon.copy(icon, icons.newChildId());
  addIcon(copy, position);
  return copy;
}

protected Component getIcon(final String id) {
  if (iconReference != null) {
    return HippoIcon.fromResource(id, iconReference);
  }
  return null;
}

/**
 * Renders a hippo icon of size {@link IconSize#M} via a reference to the icon sprite.
 * @param id the Wicket id of the icon
 * @param icon the icon to render
 * @return the icon component
 */
public static HippoIcon fromSprite(final String id, final Icon icon) {
  return fromSprite(id, icon, IconSize.M);
}

@Override
protected Component getIcon(final String id) {
  return HippoIcon.inline(id, CmsIcon.FILE_UNLOCKED);
}

@Override
protected Component newNodeIcon(final MarkupContainer parent, final String id, final TreeNode node) {
  ResourceReference nodeIcon = super.getNodeIcon(node);
  return HippoIcon.fromResource(id, nodeIcon);
}

@Override
protected Component getIcon(final String id) {
  return HippoIcon.fromSprite(id, Icon.GLOBE);
}

@Override
protected Component getIcon(final String id) {
  return HippoIcon.inline(id, CmsIcon.FLOPPY_TIMES_CIRCLE);
}

public HippoIcon addFromResource(final ResourceReference reference, final Position position) {
  final HippoIcon resourceIcon = HippoIcon.fromResource(icons.newChildId(), reference);
  addIcon(resourceIcon, position);
  return resourceIcon;
}