org.devacfr.maven.skins.reflow.model

Class Menu

java.lang.Object

org.devacfr.maven.skins.reflow.model.Menu

public class Menu
extends Object

Since:

2.0

Author:

Christophe Friederich

Constructor Summary

Constructors

Constructor and Description
Menu(ISkinConfig config, org.apache.maven.doxia.site.LinkItem item) Initialize with LinkItem.
Menu(ISkinConfig config, org.apache.maven.doxia.site.Menu menu) Initialize with Menu.

Method Summary

Modifier and Type	Method and Description
String	getHref()
org.apache.maven.doxia.site.Image	getImage()
String	getInherit()
List<MenuItem>	getMenuItems()
String	getName()
String	getTarget()
boolean	isActive()
static boolean	matches(String regex, org.apache.maven.doxia.site.Menu menu) Gets indicating whether menu by their ref or name, and returns the matching results.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Menu

public Menu(@Nonnull
            ISkinConfig config,
            @Nonnull
            org.apache.maven.doxia.site.LinkItem item)

Initialize with LinkItem.

Parameters:

config - a config (can not be null).

item - link item used to.

Menu

public Menu(@Nonnull
            ISkinConfig config,
            @Nonnull
            org.apache.maven.doxia.site.Menu menu)

Initialize with Menu.

Parameters:

config - a config (can not be null).

menu - menu used to.

Method Detail

getMenuItems

public List<MenuItem> getMenuItems()

Returns:

the menuItems

getName

public String getName()

Returns:

the name

getInherit

public String getInherit()

Returns:

the inherit

isActive

public boolean isActive()

Returns:

the active

getHref

public String getHref()

Returns:

the href

getImage

public org.apache.maven.doxia.site.Image getImage()

Returns:

the image

getTarget

public String getTarget()

Returns:

the target

matches

public static boolean matches(@Nonnull
                              String regex,
                              @Nonnull
                              org.apache.maven.doxia.site.Menu menu)

Gets indicating whether menu by their ref or name, and returns the matching results. The regex is used to check the match.

Parameters:

regex - regex to use.

menu - the menu to check

Returns:

Returns true whether menu matches with regex.