org.nasdanika.html.model.components.TableOfContentsBase Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of model-components Show documentation
The newest version!
/**
 */
package org.nasdanika.html.model.components;

import org.nasdanika.html.model.bootstrap.BootstrapElement;

/**
 * 
 * A representation of the model object 'Table Of Contents Base'.
 * 
 *
 * 
 * Base class for tables of content.
 * 
 *
 * 
 * The following features are supported:
 * 
 * 
 *   {@link org.nasdanika.html.model.components.TableOfContentsBase#getHeader Header}
 *   {@link org.nasdanika.html.model.components.TableOfContentsBase#getRole Role}
 *   {@link org.nasdanika.html.model.components.TableOfContentsBase#getDepth Depth}
 * 
 *
 * @see org.nasdanika.html.model.components.ComponentsPackage#getTableOfContentsBase()
 * @model abstract="true"
 * @generated
 */
public interface TableOfContentsBase extends BootstrapElement {
	/**
	 * Returns the value of the 'Header' attribute.
	 * The default value is "".
	 * 
	 * 
	 * 
	 * Table of contents header
	 * 
	 * @return the value of the 'Header' attribute.
	 * @see #setHeader(String)
	 * @see org.nasdanika.html.model.components.ComponentsPackage#getTableOfContentsBase_Header()
	 * @model default=""
	 * @generated
	 */
	String getHeader();

	/**
	 * Sets the value of the '{@link org.nasdanika.html.model.components.TableOfContentsBase#getHeader Header}' attribute.
	 * 
	 * 
	 * @param value the new value of the 'Header' attribute.
	 * @see #getHeader()
	 * @generated
	 */
	void setHeader(String value);

	/**
	 * Returns the value of the 'Role' attribute.
	 * The default value is "".
	 * 
	 * 
	 * 
	 * Table of contents includes action children in the specified role - navigation or section.
	 * 
	 * @return the value of the 'Role' attribute.
	 * @see #setRole(String)
	 * @see org.nasdanika.html.model.components.ComponentsPackage#getTableOfContentsBase_Role()
	 * @model default=""
	 * @generated
	 */
	String getRole();

	/**
	 * Sets the value of the '{@link org.nasdanika.html.model.components.TableOfContentsBase#getRole Role}' attribute.
	 * 
	 * 
	 * @param value the new value of the 'Role' attribute.
	 * @see #getRole()
	 * @generated
	 */
	void setRole(String value);

	/**
	 * Returns the value of the 'Depth' attribute.
	 * The default value is "3".
	 * 
	 * 
	 * 
	 * Table of contents depth.
	 * 
	 * @return the value of the 'Depth' attribute.
	 * @see #setDepth(int)
	 * @see org.nasdanika.html.model.components.ComponentsPackage#getTableOfContentsBase_Depth()
	 * @model default="3"
	 * @generated
	 */
	int getDepth();

	/**
	 * Sets the value of the '{@link org.nasdanika.html.model.components.TableOfContentsBase#getDepth Depth}' attribute.
	 * 
	 * 
	 * @param value the new value of the 'Depth' attribute.
	 * @see #getDepth()
	 * @generated
	 */
	void setDepth(int value);

} // TableOfContentsBase