org.nasdanika.html.model.app.Action Maven / Gradle / Ivy
/**
*/
package org.nasdanika.html.model.app;
import org.eclipse.emf.common.util.EList;
import org.eclipse.emf.ecore.EObject;
import org.nasdanika.exec.resources.Resource;
/**
*
* A representation of the model object 'Action'.
*
*
*
* Actions form a hierarchy. Application pages are generated from actions.
*
*
*
* The following features are supported:
*
*
* - {@link org.nasdanika.html.model.app.Action#getSectionColumns Section Columns}
* - {@link org.nasdanika.html.model.app.Action#getSectionStyle Section Style}
* - {@link org.nasdanika.html.model.app.Action#getSections Sections}
* - {@link org.nasdanika.html.model.app.Action#getNavigation Navigation}
* - {@link org.nasdanika.html.model.app.Action#getLeftNavigation Left Navigation}
* - {@link org.nasdanika.html.model.app.Action#getRightNavigation Right Navigation}
* - {@link org.nasdanika.html.model.app.Action#getFloatLeftNavigation Float Left Navigation}
* - {@link org.nasdanika.html.model.app.Action#getFloatRightNavigation Float Right Navigation}
* - {@link org.nasdanika.html.model.app.Action#getAnonymous Anonymous}
* - {@link org.nasdanika.html.model.app.Action#getResources Resources}
* - {@link org.nasdanika.html.model.app.Action#isInline Inline}
* - {@link org.nasdanika.html.model.app.Action#isModalActivator Modal Activator}
*
*
* @see org.nasdanika.html.model.app.AppPackage#getAction()
* @model
* @generated
*/
public interface Action extends Link {
/**
* 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#getAction_SectionColumns()
* @model default="3"
* @generated
*/
int getSectionColumns();
/**
* Sets the value of the '{@link org.nasdanika.html.model.app.Action#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 "Header".
* 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#getAction_SectionStyle()
* @model default="Header"
* @generated
*/
SectionStyle getSectionStyle();
/**
* Sets the value of the '{@link org.nasdanika.html.model.app.Action#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);
/**
* Returns the value of the 'Sections' containment reference list.
* The list contents are of type {@link org.nasdanika.html.model.app.Action}.
*
*
*
* Actions which are generated into content sections. Id's of section actions are used to create URL fragments.
*
* @return the value of the 'Sections' containment reference list.
* @see org.nasdanika.html.model.app.AppPackage#getAction_Sections()
* @model containment="true"
* annotation="urn:org.nasdanika homogeneous='true'"
* @generated
*/
EList getSections();
/**
* Returns the value of the 'Navigation' containment reference list.
* The list contents are of type {@link org.eclipse.emf.ecore.EObject}.
*
*
*
* Navigation items are displayed in the footer the root action, in the navigation bar for the principal action, and in the content panel navigation bar for the active action.
*
* @return the value of the 'Navigation' containment reference list.
* @see org.nasdanika.html.model.app.AppPackage#getAction_Navigation()
* @model containment="true"
* @generated
*/
EList getNavigation();
/**
* Returns the value of the 'Left Navigation' containment reference.
*
*
*
* Left navigation panel
*
* @return the value of the 'Left Navigation' containment reference.
* @see #setLeftNavigation(NavigationPanel)
* @see org.nasdanika.html.model.app.AppPackage#getAction_LeftNavigation()
* @model containment="true"
* annotation="urn:org.nasdanika homogeneous='true'"
* @generated
*/
NavigationPanel getLeftNavigation();
/**
* Sets the value of the '{@link org.nasdanika.html.model.app.Action#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.
*
*
*
* Right navigation panel.
*
* @return the value of the 'Right Navigation' containment reference.
* @see #setRightNavigation(NavigationPanel)
* @see org.nasdanika.html.model.app.AppPackage#getAction_RightNavigation()
* @model containment="true"
* annotation="urn:org.nasdanika homogeneous='true'"
* @generated
*/
NavigationPanel getRightNavigation();
/**
* Sets the value of the '{@link org.nasdanika.html.model.app.Action#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.
*
*
*
* Float left navigation panel.
*
* @return the value of the 'Float Left Navigation' containment reference.
* @see #setFloatLeftNavigation(NavigationPanel)
* @see org.nasdanika.html.model.app.AppPackage#getAction_FloatLeftNavigation()
* @model containment="true"
* annotation="urn:org.nasdanika homogeneous='true'"
* @generated
*/
NavigationPanel getFloatLeftNavigation();
/**
* Sets the value of the '{@link org.nasdanika.html.model.app.Action#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.
*
*
*
* Float right navigation panel.
*
* @return the value of the 'Float Right Navigation' containment reference.
* @see #setFloatRightNavigation(NavigationPanel)
* @see org.nasdanika.html.model.app.AppPackage#getAction_FloatRightNavigation()
* @model containment="true"
* annotation="urn:org.nasdanika homogeneous='true'"
* @generated
*/
NavigationPanel getFloatRightNavigation();
/**
* Sets the value of the '{@link org.nasdanika.html.model.app.Action#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 'Anonymous' containment reference list.
* The list contents are of type {@link org.nasdanika.html.model.app.Action}.
*
*
*
* Actions which are not shown in the containing action UI, but for which pages are generated and can be explicitly referenced, e.g. from content.
*
* @return the value of the 'Anonymous' containment reference list.
* @see org.nasdanika.html.model.app.AppPackage#getAction_Anonymous()
* @model containment="true"
* @generated
*/
EList getAnonymous();
/**
* Returns the value of the 'Resources' containment reference list.
* The list contents are of type {@link org.nasdanika.exec.resources.Resource}.
*
*
*
* Resources referenced by the page. Resource names are resolved relative to the page location.
*
* @return the value of the 'Resources' containment reference list.
* @see org.nasdanika.html.model.app.AppPackage#getAction_Resources()
* @model containment="true"
* @generated
*/
EList getResources();
/**
* Returns the value of the 'Inline' attribute.
*
*
*
* Inline action's content is displayed instead of an action link in navigation panels.
*
* @return the value of the 'Inline' attribute.
* @see #setInline(boolean)
* @see org.nasdanika.html.model.app.AppPackage#getAction_Inline()
* @model annotation="urn:org.nasdanika exclusive-with='location binding script modal'"
* @generated
*/
boolean isInline();
/**
* Sets the value of the '{@link org.nasdanika.html.model.app.Action#isInline Inline}' attribute.
*
*
* @param value the new value of the 'Inline' attribute.
* @see #isInline()
* @generated
*/
void setInline(boolean value);
/**
* Returns the value of the 'Modal Activator' attribute.
*
*
*
* Inline action's content is displayed in a modal dialog which opens on a click on the action's link.
*
* @return the value of the 'Modal Activator' attribute.
* @see #setModalActivator(boolean)
* @see org.nasdanika.html.model.app.AppPackage#getAction_ModalActivator()
* @model annotation="urn:org.nasdanika exclusive-with='location binding script inline'"
* @generated
*/
boolean isModalActivator();
/**
* Sets the value of the '{@link org.nasdanika.html.model.app.Action#isModalActivator Modal Activator}' attribute.
*
*
* @param value the new value of the 'Modal Activator' attribute.
* @see #isModalActivator()
* @generated
*/
void setModalActivator(boolean value);
/**
*
*
*
* Creates a link pointing to this action and populated with action's text, icon, tooltip, and uuid attributes.
*
* @model required="true"
* @generated
*/
Link createLink();
} // Action