org.nasdanika.html.model.app.NavigationPanel 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;

/**
 * 
 * A representation of the model object 'Navigation Panel'.
 * 
 *
 * 
 * Navigation panel contains navigation items. Supports several styles.
 * 
 *
 * 
 * The following features are supported:
 * 
 * 
 *   {@link org.nasdanika.html.model.app.NavigationPanel#getStyle Style}
 *   {@link org.nasdanika.html.model.app.NavigationPanel#getId Id}
 *   {@link org.nasdanika.html.model.app.NavigationPanel#getLabelTrimLength Label Trim Length}
 *   {@link org.nasdanika.html.model.app.NavigationPanel#isCollapsible Collapsible}
 *   {@link org.nasdanika.html.model.app.NavigationPanel#getJsTreeSearchThreshold Js Tree Search Threshold}
 * 
 *
 * @see org.nasdanika.html.model.app.AppPackage#getNavigationPanel()
 * @model
 * @generated
 */
public interface NavigationPanel extends PagePart {
	/**
	 * Returns the value of the 'Style' attribute.
	 * The default value is "Auto".
	 * The literals are from the enumeration {@link org.nasdanika.html.model.app.NavigationPanelStyle}.
	 * 
	 * 
	 * 
	 * Panel style
	 * 
	 * @return the value of the 'Style' attribute.
	 * @see org.nasdanika.html.model.app.NavigationPanelStyle
	 * @see #setStyle(NavigationPanelStyle)
	 * @see org.nasdanika.html.model.app.AppPackage#getNavigationPanel_Style()
	 * @model default="Auto"
	 * @generated
	 */
	NavigationPanelStyle getStyle();

	/**
	 * Sets the value of the '{@link org.nasdanika.html.model.app.NavigationPanel#getStyle Style}' attribute.
	 * 
	 * 
	 * @param value the new value of the 'Style' attribute.
	 * @see org.nasdanika.html.model.app.NavigationPanelStyle
	 * @see #getStyle()
	 * @generated
	 */
	void setStyle(NavigationPanelStyle value);

	/**
	 * Returns the value of the 'Id' attribute.
	 * 
	 * 
	 * 
	 * ID for jsTree to store state between pages, e.g. expaned nodes.
	 * 
	 * @return the value of the 'Id' attribute.
	 * @see #setId(String)
	 * @see org.nasdanika.html.model.app.AppPackage#getNavigationPanel_Id()
	 * @model
	 * @generated
	 */
	String getId();

	/**
	 * Sets the value of the '{@link org.nasdanika.html.model.app.NavigationPanel#getId Id}' attribute.
	 * 
	 * 
	 * @param value the new value of the 'Id' attribute.
	 * @see #getId()
	 * @generated
	 */
	void setId(String value);

	/**
	 * Returns the value of the 'Label Trim Length' attribute.
	 * The default value is "50".
	 * 
	 * 
	 * @return the value of the 'Label Trim Length' attribute.
	 * @see #setLabelTrimLength(int)
	 * @see org.nasdanika.html.model.app.AppPackage#getNavigationPanel_LabelTrimLength()
	 * @model default="50"
	 * @generated
	 */
	int getLabelTrimLength();

	/**
	 * Sets the value of the '{@link org.nasdanika.html.model.app.NavigationPanel#getLabelTrimLength Label Trim Length}' attribute.
	 * 
	 * 
	 * @param value the new value of the 'Label Trim Length' attribute.
	 * @see #getLabelTrimLength()
	 * @generated
	 */
	void setLabelTrimLength(int value);

	/**
	 * Returns the value of the 'Collapsible' attribute.
	 * 
	 * 
	 * @return the value of the 'Collapsible' attribute.
	 * @see #setCollapsible(boolean)
	 * @see org.nasdanika.html.model.app.AppPackage#getNavigationPanel_Collapsible()
	 * @model
	 * @generated
	 */
	boolean isCollapsible();

	/**
	 * Sets the value of the '{@link org.nasdanika.html.model.app.NavigationPanel#isCollapsible Collapsible}' attribute.
	 * 
	 * 
	 * @param value the new value of the 'Collapsible' attribute.
	 * @see #isCollapsible()
	 * @generated
	 */
	void setCollapsible(boolean value);

	/**
	 * Returns the value of the 'Js Tree Search Threshold' attribute.
	 * 
	 * 
	 * 
	 * Minimal number of tree nodes to show a search text input. Default is 0 - search is always shown.
	 * 
	 * @return the value of the 'Js Tree Search Threshold' attribute.
	 * @see #setJsTreeSearchThreshold(int)
	 * @see org.nasdanika.html.model.app.AppPackage#getNavigationPanel_JsTreeSearchThreshold()
	 * @model
	 * @generated
	 */
	int getJsTreeSearchThreshold();

	/**
	 * Sets the value of the '{@link org.nasdanika.html.model.app.NavigationPanel#getJsTreeSearchThreshold Js Tree Search Threshold}' attribute.
	 * 
	 * 
	 * @param value the new value of the 'Js Tree Search Threshold' attribute.
	 * @see #getJsTreeSearchThreshold()
	 * @generated
	 */
	void setJsTreeSearchThreshold(int value);

} // NavigationPanel