org.docgene.model

Class XMLMenu

java.lang.Object

org.docgene.model.AbstractStyledElement

org.docgene.model.XMLMenu

All Implemented Interfaces:

ParagraphElement, StyledElement

public class XMLMenu
extends AbstractStyledElement

A left or right menu.

Field Summary

Fields inherited from interface org.docgene.model.StyledElement

TYPE_NONE

Constructor Summary

Constructors

Constructor and Description
XMLMenu() Constructor.
XMLMenu(ArticlesModel model) Constructor.

Method Summary

Modifier and Type	Method and Description
boolean	addDefaultMenuItem(short itemType) Add a default menu item to the menu.
void	addMenuItem(AbstractMenuItem item) Add a menu item to the menu.
java.util.List<java.lang.String>	getCustomMenu() Return the additional custom HTML menu.
java.util.List<AbstractMenuItem>	getMenuItems() Return the menu items.
boolean	hasCustomMenu() Return true if the menu has a custom HTML content.
boolean	hasCustomMenuItems() Return true if the menu has custom menu items.
boolean	hasFixedMenuOptions() Return true if the options in the menu are always present.
boolean	hasGlossaryItem() Return true if the menu has a custom glossary item.
boolean	hasMenuItems() Return true if the menu has menu items.
void	initDefaultContent() Initialize the default content.
boolean	isEmpty() Return true if the menu is empty.
void	setCustomMenu(java.util.List<java.lang.String> customMenu) Set an additional custom HTML menu.
void	setDefaultContent(boolean hasDefaultContent) Set if the menu must have a default content.
void	setFixedMenuOptions(boolean fixedMenuOptions) Set if the options in the menu are always present.

Methods inherited from class org.docgene.model.AbstractStyledElement

getCustomStyles, getInlinedStyle, setCustomStyles, setInlinedStyle

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.docgene.model.StyledElement

getDeclaration, getStyle, hasInlinedStyle, setCustomStyles

Constructor Detail

XMLMenu

public XMLMenu(ArticlesModel model)

Constructor.

Parameters:

model - the articles model

XMLMenu

public XMLMenu()

Constructor.

Method Detail

setFixedMenuOptions

public void setFixedMenuOptions(boolean fixedMenuOptions)

Set if the options in the menu are always present. Note ythat it is only used in the left menu.

Parameters:

fixedMenuOptions - true if the options in the menu are always present

hasFixedMenuOptions

public boolean hasFixedMenuOptions()

Return true if the options in the menu are always present.

Returns:

true if the options in the menu are always present

initDefaultContent

public void initDefaultContent()

Initialize the default content.

setDefaultContent

public void setDefaultContent(boolean hasDefaultContent)

Set if the menu must have a default content.

Parameters:

hasDefaultContent - true if the menu must have a default content

hasCustomMenu

public boolean hasCustomMenu()

Return true if the menu has a custom HTML content.

Returns:

true if the menu has a custom HTML content

isEmpty

public boolean isEmpty()

Return true if the menu is empty.

Returns:

true if the menu is empty

hasMenuItems

public boolean hasMenuItems()

Return true if the menu has menu items.

Returns:

true if the menu has menu items

hasCustomMenuItems

public boolean hasCustomMenuItems()

Return true if the menu has custom menu items.

Returns:

true if the menu has custom menu items

hasGlossaryItem

public boolean hasGlossaryItem()

Return true if the menu has a custom glossary item.

Returns:

true if the menu has a custom glossary item

addDefaultMenuItem

public boolean addDefaultMenuItem(short itemType)

Add a default menu item to the menu.

Parameters:

itemType - the menu item type

Returns:

true if the item type exists

See Also:

DefaultMenuItem

addMenuItem

public void addMenuItem(AbstractMenuItem item)

Add a menu item to the menu.

Parameters:

item - the menu item

getMenuItems

public java.util.List<AbstractMenuItem> getMenuItems()

Return the menu items.

Returns:

the menu items

setCustomMenu

public void setCustomMenu(java.util.List<java.lang.String> customMenu)

Set an additional custom HTML menu.

Parameters:

customMenu - the additional custom HTML menu

getCustomMenu

public java.util.List<java.lang.String> getCustomMenu()

Return the additional custom HTML menu.

Returns:

the additional custom HTML menu