In package com.eden.orchid.api.theme.components

@Extensible
public abstract class OrchidComponent extends Prioritized implements OptionsHolder, AssetHolder, ModularPageListItem<L, I>

since: v1.0.0 public abstract

Fields

OrchidContext context final

String type final
Field Annotations:
@Getter

AssetHolder assetHolder final
Field Annotations:
@Getter

OrchidPage page
Field Annotations:
@Setter

String[] template
Field Annotations:
@Getter,
@Setter,
@Option,
@Description(
    value="Specify a template or a list of templates to use when rendering this component. The first template that exists will be chosen for this component.")

int order
Field Annotations:
@Getter,
@Setter,
@Option,
@IntDefault(
    value=0),
@Description(
    value="By default, components are rendered in the order in which they are declared, but the ordering can be changed by setting the order on any individual component. A higher value for order will render that component earlier in the list.")

String[] extraCss
Field Annotations:
@Getter,
@Setter,
@Option,
@Description(
    value="Add extra CSS files to the page containing this Component, which will be compiled just like the rest of the site\'s assets.")

String[] extraJs
Field Annotations:
@Getter,
@Setter,
@Option,
@Description(
    value="Add extra Javascript files to the page containing this Component, which will be compiled just like the rest of the site\'s assets.")

boolean hidden
Field Annotations:
@Getter,
@Setter,
@Option,
@BooleanDefault(
    value=false),
@Description(
    value="When true, this component will not have a template rendered on the page. Useful for Components that only add extra CSS or JS, or for temporarily removing a component from the page.")

boolean noWrapper
Field Annotations:
@Getter,
@Setter,
@Option,
@BooleanDefault(
    value=false),
@Description(
    value="When true, this component will not be wrapped in a wrapper element. The wrapper element is determinedby the theme, and it is up to the theme to ensure this is implemented properly.")

Constructors

OrchidComponent(OrchidContext context, String type, int priority) public
Constructor Annotations:
@Inject

Parameters:

Methods

List<E> getTemplates() public

void canBeUsedOnPage(OrchidPage containingPage, ComponentHolder componentHolder, List<E> possibleComponents, List<E> currentComponents) public
Method Annotations:
@Override

Parameters:
void addAssets() final public
Method Annotations:
@Override

List<E> getScripts() final public
Method Annotations:
@Override

List<E> getStyles() final public
Method Annotations:
@Override

void loadAssets() protected