- getAddDefaultEntities() - Method in class org.apache.maven.doxia.site.decoration.io.xpp3.DecorationXpp3Reader
-
Returns the state of the "add default entities" flag.
- getAlt() - Method in class org.apache.maven.doxia.site.decoration.Banner
-
Get the alt description for the banner image.
- getAlt() - Method in class org.apache.maven.doxia.site.decoration.LinkItem
-
Get the alt to use for the image.
- getAlt() - Method in class org.apache.maven.doxia.site.decoration.Menu
-
Get the alt description for the image.
- getArtifactId() - Method in class org.apache.maven.doxia.site.decoration.Skin
-
Get the skin artifact ID.
- getBannerLeft() - Method in class org.apache.maven.doxia.site.decoration.DecorationModel
-
Get banner logo on the masthead of the site to the left.
- getBannerRight() - Method in class org.apache.maven.doxia.site.decoration.DecorationModel
-
Get banner logo on the masthead of the site to the right.
- getBaseURI() - Method in class org.apache.maven.doxia.site.decoration.inheritance.URIPathDescriptor
-
Return the base of this URIPathDescriptor as a URI.
- getBaseUrl() - Method in class org.apache.maven.doxia.site.decoration.inheritance.PathDescriptor
-
Deprecated.
Get the base URL.
- getBody() - Method in class org.apache.maven.doxia.site.decoration.DecorationModel
-
Get the main site content decoration.
- getBorder() - Method in class org.apache.maven.doxia.site.decoration.Banner
-
Get the border to use for the banner image.
- getBorder() - Method in class org.apache.maven.doxia.site.decoration.LinkItem
-
Get the border to use for the image.
- getBorder() - Method in class org.apache.maven.doxia.site.decoration.Menu
-
Get the border to use for the menu image.
- getBreadcrumbs() - Method in class org.apache.maven.doxia.site.decoration.Body
-
Method getBreadcrumbs.
- getCombineSelf() - Method in class org.apache.maven.doxia.site.decoration.DecorationModel
-
Get whether to inherit configuration from a parent project
site descriptor (merge
)
or not (override
).
- getCustom() - Method in class org.apache.maven.doxia.site.decoration.DecorationModel
-
Get custom configuration for use with customized Velocity
templates.
- getDefaultSkin() - Static method in class org.apache.maven.doxia.site.decoration.Skin
-
- getDescription() - Method in class org.apache.maven.doxia.site.decoration.MenuItem
-
Get a description of the menu item.
- getFooter() - Method in class org.apache.maven.doxia.site.decoration.Body
-
Get if present, the contained text will be used instead of
the generated copyright text.
- getFormat() - Method in class org.apache.maven.doxia.site.decoration.PublishDate
-
Get date format to use.
- getGoogleAdSenseClient() - Method in class org.apache.maven.doxia.site.decoration.DecorationModel
-
Get your Google AdSense client id.
- getGoogleAdSenseSlot() - Method in class org.apache.maven.doxia.site.decoration.DecorationModel
-
Get your Google AdSense slot id.
- getGoogleAnalyticsAccountId() - Method in class org.apache.maven.doxia.site.decoration.DecorationModel
-
Get the id for your Google Analytics account.
- getGroupId() - Method in class org.apache.maven.doxia.site.decoration.Skin
-
Get the skin group ID.
- getHead() - Method in class org.apache.maven.doxia.site.decoration.Body
-
Get additional content (like JavaScript) to include in the
HEAD block of the generated pages.
- getHeight() - Method in class org.apache.maven.doxia.site.decoration.Banner
-
Get the height to use for the banner image.
- getHeight() - Method in class org.apache.maven.doxia.site.decoration.LinkItem
-
Get the height to use for the image.
- getHeight() - Method in class org.apache.maven.doxia.site.decoration.Menu
-
Get the height to use for the menu image.
- getHref() - Method in class org.apache.maven.doxia.site.decoration.Banner
-
Get the href of a link to be used for the banner image.
- getHref() - Method in class org.apache.maven.doxia.site.decoration.LinkItem
-
Get the href to use for the link.
- getImg() - Method in class org.apache.maven.doxia.site.decoration.LinkItem
-
Get the source location of an image.
- getImg() - Method in class org.apache.maven.doxia.site.decoration.Menu
-
Get the source location of an menu image.
- getInherit() - Method in class org.apache.maven.doxia.site.decoration.Menu
-
Get the way in which the menu is inherited.
- getItems() - Method in class org.apache.maven.doxia.site.decoration.Menu
-
Method getItems.
- getItems() - Method in class org.apache.maven.doxia.site.decoration.MenuItem
-
Method getItems.
- getLastModified() - Method in class org.apache.maven.doxia.site.decoration.DecorationModel
-
Get timestamp of the last modification of this decoration
model.
- getLink() - Method in class org.apache.maven.doxia.site.decoration.inheritance.URIPathDescriptor
-
Return the link of this URIPathDescriptor as a URI.
- getLinks() - Method in class org.apache.maven.doxia.site.decoration.Body
-
Method getLinks.
- getLocation() - Method in class org.apache.maven.doxia.site.decoration.inheritance.PathDescriptor
-
Deprecated.
Get the location for files.
- getMenuRef(String) - Method in class org.apache.maven.doxia.site.decoration.DecorationModel
-
- getMenus() - Method in class org.apache.maven.doxia.site.decoration.Body
-
Method getMenus.
- getMenus() - Method in class org.apache.maven.doxia.site.decoration.DecorationModel
-
- getModelEncoding() - Method in class org.apache.maven.doxia.site.decoration.DecorationModel
-
Get the modelEncoding field.
- getName() - Method in class org.apache.maven.doxia.site.decoration.Banner
-
Get the name of the banner.
- getName() - Method in class org.apache.maven.doxia.site.decoration.DecorationModel
-
Get the full name of the project.
- getName() - Method in class org.apache.maven.doxia.site.decoration.LinkItem
-
Get the name to display for the link.
- getName() - Method in class org.apache.maven.doxia.site.decoration.Menu
-
Get the name to display for the menu.
- getPath() - Method in class org.apache.maven.doxia.site.decoration.inheritance.PathDescriptor
-
Deprecated.
Get the path.
- getPathUrl() - Method in class org.apache.maven.doxia.site.decoration.inheritance.PathDescriptor
-
Deprecated.
Get the path as a URL.
- getPosition() - Method in class org.apache.maven.doxia.site.decoration.LinkItem
-
Get where to place the image regarding the displayed name
(left or right).
- getPosition() - Method in class org.apache.maven.doxia.site.decoration.Menu
-
Get where to place the image regarding the displayed name
(left or right).
- getPosition() - Method in class org.apache.maven.doxia.site.decoration.PublishDate
-
Get where to place the date published (left, right,
navigation-top, navigation-bottom, bottom).
- getPosition() - Method in class org.apache.maven.doxia.site.decoration.Version
-
Get where to place the version published (left, right,
navigation-top, navigation-bottom, bottom).
- getPoweredBy() - Method in class org.apache.maven.doxia.site.decoration.DecorationModel
-
Method getPoweredBy.
- getPublishDate() - Method in class org.apache.maven.doxia.site.decoration.DecorationModel
-
- getRef() - Method in class org.apache.maven.doxia.site.decoration.Menu
-
Get mark this menu as reference to a pre-defined menu:
reports
, modules
or parent
.
- getRef() - Method in class org.apache.maven.doxia.site.decoration.MenuItem
-
Get a reference to a pre-defined menu item, such as a report
(specified by the report goal
name).
- getRelativePath(PathDescriptor, PathDescriptor) - Static method in class org.apache.maven.doxia.site.decoration.inheritance.PathUtils
-
Deprecated.
getRelativePath.
- getSkin() - Method in class org.apache.maven.doxia.site.decoration.DecorationModel
-
Get the artifact containing the skin for the site.
- getSrc() - Method in class org.apache.maven.doxia.site.decoration.Banner
-
Get the source location of an image for the banner.
- getTarget() - Method in class org.apache.maven.doxia.site.decoration.LinkItem
-
Get where the new document will be displayed when the user
follows a link, i.e.
- getTitle() - Method in class org.apache.maven.doxia.site.decoration.Banner
-
Get the title for the banner image.
- getTitle() - Method in class org.apache.maven.doxia.site.decoration.LinkItem
-
Get the title to use for the image.
- getTitle() - Method in class org.apache.maven.doxia.site.decoration.Menu
-
Get the title for the image.
- getVersion() - Method in class org.apache.maven.doxia.site.decoration.DecorationModel
-
- getVersion() - Method in class org.apache.maven.doxia.site.decoration.Skin
-
Get the skin version.
- getWidth() - Method in class org.apache.maven.doxia.site.decoration.Banner
-
Get the width to use for the banner image.
- getWidth() - Method in class org.apache.maven.doxia.site.decoration.LinkItem
-
Get the width to use for the image.
- getWidth() - Method in class org.apache.maven.doxia.site.decoration.Menu
-
Get the width to use for the menu image.
- sameSite(URI) - Method in class org.apache.maven.doxia.site.decoration.inheritance.URIPathDescriptor
-
Check if this URIPathDescriptor lives on the same site as the given URI.
- setAddDefaultEntities(boolean) - Method in class org.apache.maven.doxia.site.decoration.io.xpp3.DecorationXpp3Reader
-
Sets the state of the "add default entities" flag.
- setAlt(String) - Method in class org.apache.maven.doxia.site.decoration.Banner
-
Set the alt description for the banner image.
- setAlt(String) - Method in class org.apache.maven.doxia.site.decoration.LinkItem
-
Set the alt to use for the image.
- setAlt(String) - Method in class org.apache.maven.doxia.site.decoration.Menu
-
Set the alt description for the image.
- setArtifactId(String) - Method in class org.apache.maven.doxia.site.decoration.Skin
-
Set the skin artifact ID.
- setBannerLeft(Banner) - Method in class org.apache.maven.doxia.site.decoration.DecorationModel
-
Set banner logo on the masthead of the site to the left.
- setBannerRight(Banner) - Method in class org.apache.maven.doxia.site.decoration.DecorationModel
-
Set banner logo on the masthead of the site to the right.
- setBody(Body) - Method in class org.apache.maven.doxia.site.decoration.DecorationModel
-
Set the main site content decoration.
- setBorder(String) - Method in class org.apache.maven.doxia.site.decoration.Banner
-
Set the border to use for the banner image.
- setBorder(String) - Method in class org.apache.maven.doxia.site.decoration.LinkItem
-
Set the border to use for the image.
- setBorder(String) - Method in class org.apache.maven.doxia.site.decoration.Menu
-
Set the border to use for the menu image.
- setBreadcrumbs(List<LinkItem>) - Method in class org.apache.maven.doxia.site.decoration.Body
-
Set a list of breadcrumbs to display in the navigation.
- setCollapse(boolean) - Method in class org.apache.maven.doxia.site.decoration.MenuItem
-
Set whether to collapse children elements of an item menu
(by default).
- setCombineSelf(String) - Method in class org.apache.maven.doxia.site.decoration.DecorationModel
-
Set whether to inherit configuration from a parent project
site descriptor (merge
)
or not (override
).
- setCustom(Object) - Method in class org.apache.maven.doxia.site.decoration.DecorationModel
-
Set custom configuration for use with customized Velocity
templates.
- setDescription(String) - Method in class org.apache.maven.doxia.site.decoration.MenuItem
-
Set a description of the menu item.
- setFooter(String) - Method in class org.apache.maven.doxia.site.decoration.Body
-
Set if present, the contained text will be used instead of
the generated copyright text.
- setFormat(String) - Method in class org.apache.maven.doxia.site.decoration.PublishDate
-
Set date format to use.
- setGoogleAdSenseClient(String) - Method in class org.apache.maven.doxia.site.decoration.DecorationModel
-
Set your Google AdSense client id.
- setGoogleAdSenseSlot(String) - Method in class org.apache.maven.doxia.site.decoration.DecorationModel
-
Set your Google AdSense slot id.
- setGoogleAnalyticsAccountId(String) - Method in class org.apache.maven.doxia.site.decoration.DecorationModel
-
Set the id for your Google Analytics account.
- setGroupId(String) - Method in class org.apache.maven.doxia.site.decoration.Skin
-
Set the skin group ID.
- setHead(String) - Method in class org.apache.maven.doxia.site.decoration.Body
-
Set additional content (like JavaScript) to include in the
HEAD block of the generated pages.
- setHeight(String) - Method in class org.apache.maven.doxia.site.decoration.Banner
-
Set the height to use for the banner image.
- setHeight(String) - Method in class org.apache.maven.doxia.site.decoration.LinkItem
-
Set the height to use for the image.
- setHeight(String) - Method in class org.apache.maven.doxia.site.decoration.Menu
-
Set the height to use for the menu image.
- setHref(String) - Method in class org.apache.maven.doxia.site.decoration.Banner
-
Set the href of a link to be used for the banner image.
- setHref(String) - Method in class org.apache.maven.doxia.site.decoration.LinkItem
-
Set the href to use for the link.
- setImg(String) - Method in class org.apache.maven.doxia.site.decoration.LinkItem
-
Set the source location of an image.
- setImg(String) - Method in class org.apache.maven.doxia.site.decoration.Menu
-
Set the source location of an menu image.
- setInherit(String) - Method in class org.apache.maven.doxia.site.decoration.Menu
-
Set the way in which the menu is inherited.
- setInheritAsRef(boolean) - Method in class org.apache.maven.doxia.site.decoration.Menu
-
Set if this is a reference, setting
true means that it will be
populated
in the project, whereas if it is false, it is
populated in the parent and then inherited.
- setItems(List<MenuItem>) - Method in class org.apache.maven.doxia.site.decoration.Menu
-
Set a list of menu item.
- setItems(List<MenuItem>) - Method in class org.apache.maven.doxia.site.decoration.MenuItem
-
Set a list of menu item.
- setLastModified(long) - Method in class org.apache.maven.doxia.site.decoration.DecorationModel
-
Set timestamp of the last modification of this decoration
model.
- setLinks(List<LinkItem>) - Method in class org.apache.maven.doxia.site.decoration.Body
-
Set a list of links to display in the navigation.
- setMenus(List<Menu>) - Method in class org.apache.maven.doxia.site.decoration.Body
-
Set a list of menus to include in the navigation.
- setModelEncoding(String) - Method in class org.apache.maven.doxia.site.decoration.DecorationModel
-
Set the modelEncoding field.
- setName(String) - Method in class org.apache.maven.doxia.site.decoration.Banner
-
Set the name of the banner.
- setName(String) - Method in class org.apache.maven.doxia.site.decoration.DecorationModel
-
Set the full name of the project.
- setName(String) - Method in class org.apache.maven.doxia.site.decoration.LinkItem
-
Set the name to display for the link.
- setName(String) - Method in class org.apache.maven.doxia.site.decoration.Menu
-
Set the name to display for the menu.
- setPosition(String) - Method in class org.apache.maven.doxia.site.decoration.LinkItem
-
Set where to place the image regarding the displayed name
(left or right).
- setPosition(String) - Method in class org.apache.maven.doxia.site.decoration.Menu
-
Set where to place the image regarding the displayed name
(left or right).
- setPosition(String) - Method in class org.apache.maven.doxia.site.decoration.PublishDate
-
Set where to place the date published (left, right,
navigation-top, navigation-bottom, bottom).
- setPosition(String) - Method in class org.apache.maven.doxia.site.decoration.Version
-
Set where to place the version published (left, right,
navigation-top, navigation-bottom, bottom).
- setPoweredBy(List<Logo>) - Method in class org.apache.maven.doxia.site.decoration.DecorationModel
-
Set powered by logos list.
- setPublishDate(PublishDate) - Method in class org.apache.maven.doxia.site.decoration.DecorationModel
-
Set modify the date published display properties.
- setRef(String) - Method in class org.apache.maven.doxia.site.decoration.Menu
-
Set mark this menu as reference to a pre-defined menu:
reports
, modules
or parent
.
- setRef(String) - Method in class org.apache.maven.doxia.site.decoration.MenuItem
-
Set a reference to a pre-defined menu item, such as a report
(specified by the report goal
name).
- setSkin(Skin) - Method in class org.apache.maven.doxia.site.decoration.DecorationModel
-
Set the artifact containing the skin for the site.
- setSrc(String) - Method in class org.apache.maven.doxia.site.decoration.Banner
-
Set the source location of an image for the banner.
- setTarget(String) - Method in class org.apache.maven.doxia.site.decoration.LinkItem
-
Set where the new document will be displayed when the user
follows a link, i.e.
- setTitle(String) - Method in class org.apache.maven.doxia.site.decoration.Banner
-
Set the title for the banner image.
- setTitle(String) - Method in class org.apache.maven.doxia.site.decoration.LinkItem
-
Set the title to use for the image.
- setTitle(String) - Method in class org.apache.maven.doxia.site.decoration.Menu
-
Set the title for the image.
- setVersion(Version) - Method in class org.apache.maven.doxia.site.decoration.DecorationModel
-
Set modify the version published display properties.
- setVersion(String) - Method in class org.apache.maven.doxia.site.decoration.Skin
-
Set the skin version.
- setWidth(String) - Method in class org.apache.maven.doxia.site.decoration.Banner
-
Set the width to use for the banner image.
- setWidth(String) - Method in class org.apache.maven.doxia.site.decoration.LinkItem
-
Set the width to use for the image.
- setWidth(String) - Method in class org.apache.maven.doxia.site.decoration.Menu
-
Set the width to use for the menu image.
- Skin - Class in org.apache.maven.doxia.site.decoration
-
An skin artifact declaration.
- Skin() - Constructor for class org.apache.maven.doxia.site.decoration.Skin
-
- startsWithAnyIgnoreCase(String, String...) - Static method in class org.apache.maven.doxia.site.decoration.DecorationUtils
-