org.nasdanika.html.model.app.ContentPanel Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of app-model Show documentation
There is a newer version: 2024.10.0
/**
 */
package org.nasdanika.html.model.app;

import org.eclipse.emf.common.util.EList;

/**
 * 
 * A representation of the model object 'Content Panel'.
 * 
 *
 * 
 * Content panel displays the primary page conent and can have a navigation bar and several navigation panels.
 * 
 *
 * 
 * The following features are supported:
 * 
 * 
 *   {@link org.nasdanika.html.model.app.ContentPanel#getBreadcrumb Breadcrumb}
 *   {@link org.nasdanika.html.model.app.ContentPanel#getTitle Title}
 *   {@link org.nasdanika.html.model.app.ContentPanel#getLeftNavigation Left Navigation}
 *   {@link org.nasdanika.html.model.app.ContentPanel#getRightNavigation Right Navigation}
 *   {@link org.nasdanika.html.model.app.ContentPanel#getFloatLeftNavigation Float Left Navigation}
 *   {@link org.nasdanika.html.model.app.ContentPanel#getFloatRightNavigation Float Right Navigation}
 *   {@link org.nasdanika.html.model.app.ContentPanel#getSections Sections}
 *   {@link org.nasdanika.html.model.app.ContentPanel#getSectionColumns Section Columns}
 *   {@link org.nasdanika.html.model.app.ContentPanel#getSectionStyle Section Style}
 * 
 *
 * @see org.nasdanika.html.model.app.AppPackage#getContentPanel()
 * @model
 * @generated
 */
public interface ContentPanel extends PagePart {
	/**
	 * Returns the value of the 'Title' containment reference.
	 * 
	 * 
	 * 
	 * Content title
	 * 
	 * @return the value of the 'Title' containment reference.
	 * @see #setTitle(Label)
	 * @see org.nasdanika.html.model.app.AppPackage#getContentPanel_Title()
	 * @model containment="true"
	 * @generated
	 */
	Label getTitle();

	/**
	 * Sets the value of the '{@link org.nasdanika.html.model.app.ContentPanel#getTitle Title}' containment reference.
	 * 
	 * 
	 * @param value the new value of the 'Title' containment reference.
	 * @see #getTitle()
	 * @generated
	 */
	void setTitle(Label value);

	/**
	 * Returns the value of the 'Breadcrumb' containment reference list.
	 * The list contents are of type {@link org.nasdanika.html.model.app.Label}.
	 * 
	 * 
	 * 
	 * Breadcrumb items. Displayed on the top of the content panel.
	 * 
	 * @return the value of the 'Breadcrumb' containment reference list.
	 * @see org.nasdanika.html.model.app.AppPackage#getContentPanel_Breadcrumb()
	 * @model containment="true"
	 * @generated
	 */
	EList getBreadcrumb();

	/**
	 * Returns the value of the 'Left Navigation' containment reference.
	 * 
	 * 
	 * 
	 * Navigation panel to display on the left of the content.
	 * 
	 * @return the value of the 'Left Navigation' containment reference.
	 * @see #setLeftNavigation(NavigationPanel)
	 * @see org.nasdanika.html.model.app.AppPackage#getContentPanel_LeftNavigation()
	 * @model containment="true"
	 *        annotation="urn:org.nasdanika homogeneous='true'"
	 * @generated
	 */
	NavigationPanel getLeftNavigation();

	/**
	 * Sets the value of the '{@link org.nasdanika.html.model.app.ContentPanel#getLeftNavigation Left Navigation}' containment reference.
	 * 
	 * 
	 * @param value the new value of the 'Left Navigation' containment reference.
	 * @see #getLeftNavigation()
	 * @generated
	 */
	void setLeftNavigation(NavigationPanel value);

	/**
	 * Returns the value of the 'Right Navigation' containment reference.
	 * 
	 * 
	 * 
	 * Navigation panel to display on the right of the content.
	 * 
	 * @return the value of the 'Right Navigation' containment reference.
	 * @see #setRightNavigation(NavigationPanel)
	 * @see org.nasdanika.html.model.app.AppPackage#getContentPanel_RightNavigation()
	 * @model containment="true"
	 *        annotation="urn:org.nasdanika homogeneous='true'"
	 * @generated
	 */
	NavigationPanel getRightNavigation();

	/**
	 * Sets the value of the '{@link org.nasdanika.html.model.app.ContentPanel#getRightNavigation Right Navigation}' containment reference.
	 * 
	 * 
	 * @param value the new value of the 'Right Navigation' containment reference.
	 * @see #getRightNavigation()
	 * @generated
	 */
	void setRightNavigation(NavigationPanel value);

	/**
	 * Returns the value of the 'Float Left Navigation' containment reference.
	 * 
	 * 
	 * 
	 * Navigation panel which float to the left of the content.
	 * 
	 * @return the value of the 'Float Left Navigation' containment reference.
	 * @see #setFloatLeftNavigation(NavigationPanel)
	 * @see org.nasdanika.html.model.app.AppPackage#getContentPanel_FloatLeftNavigation()
	 * @model containment="true"
	 *        annotation="urn:org.nasdanika homogeneous='true'"
	 * @generated
	 */
	NavigationPanel getFloatLeftNavigation();

	/**
	 * Sets the value of the '{@link org.nasdanika.html.model.app.ContentPanel#getFloatLeftNavigation Float Left Navigation}' containment reference.
	 * 
	 * 
	 * @param value the new value of the 'Float Left Navigation' containment reference.
	 * @see #getFloatLeftNavigation()
	 * @generated
	 */
	void setFloatLeftNavigation(NavigationPanel value);

	/**
	 * Returns the value of the 'Float Right Navigation' containment reference.
	 * 
	 * 
	 * 
	 * Navigation panel which floats to the right of the content.
	 * 
	 * @return the value of the 'Float Right Navigation' containment reference.
	 * @see #setFloatRightNavigation(NavigationPanel)
	 * @see org.nasdanika.html.model.app.AppPackage#getContentPanel_FloatRightNavigation()
	 * @model containment="true"
	 *        annotation="urn:org.nasdanika homogeneous='true'"
	 * @generated
	 */
	NavigationPanel getFloatRightNavigation();

	/**
	 * Sets the value of the '{@link org.nasdanika.html.model.app.ContentPanel#getFloatRightNavigation Float Right Navigation}' containment reference.
	 * 
	 * 
	 * @param value the new value of the 'Float Right Navigation' containment reference.
	 * @see #getFloatRightNavigation()
	 * @generated
	 */
	void setFloatRightNavigation(NavigationPanel value);

	/**
	 * Returns the value of the 'Sections' containment reference list.
	 * The list contents are of type {@link org.nasdanika.html.model.app.ContentPanel}.
	 * 
	 * 
	 * 
	 * Content sections.
	 * 
	 * @return the value of the 'Sections' containment reference list.
	 * @see org.nasdanika.html.model.app.AppPackage#getContentPanel_Sections()
	 * @model containment="true"
	 *        annotation="urn:org.nasdanika homogeneous='true'"
	 * @generated
	 */
	EList getSections();

	/**
	 * Returns the value of the 'Section Columns' attribute.
	 * The default value is "3".
	 * 
	 * 
	 * 
	 * Applicable to section style "Card". Defines how many columns shall be in a row of section cards.
	 * 
	 * @return the value of the 'Section Columns' attribute.
	 * @see #setSectionColumns(int)
	 * @see org.nasdanika.html.model.app.AppPackage#getContentPanel_SectionColumns()
	 * @model default="3"
	 * @generated
	 */
	int getSectionColumns();

	/**
	 * Sets the value of the '{@link org.nasdanika.html.model.app.ContentPanel#getSectionColumns Section Columns}' attribute.
	 * 
	 * 
	 * @param value the new value of the 'Section Columns' attribute.
	 * @see #getSectionColumns()
	 * @generated
	 */
	void setSectionColumns(int value);

	/**
	 * Returns the value of the 'Section Style' attribute.
	 * The default value is "Auto".
	 * The literals are from the enumeration {@link org.nasdanika.html.model.app.SectionStyle}.
	 * 
	 * 
	 * 
	 * Defines how to generate section children.
	 * 
	 * @return the value of the 'Section Style' attribute.
	 * @see org.nasdanika.html.model.app.SectionStyle
	 * @see #setSectionStyle(SectionStyle)
	 * @see org.nasdanika.html.model.app.AppPackage#getContentPanel_SectionStyle()
	 * @model default="Auto"
	 * @generated
	 */
	SectionStyle getSectionStyle();

	/**
	 * Sets the value of the '{@link org.nasdanika.html.model.app.ContentPanel#getSectionStyle Section Style}' attribute.
	 * 
	 * 
	 * @param value the new value of the 'Section Style' attribute.
	 * @see org.nasdanika.html.model.app.SectionStyle
	 * @see #getSectionStyle()
	 * @generated
	 */
	void setSectionStyle(SectionStyle value);

} // ContentPanel