LEONARDI Application Composer - 8.9.0.40 by W4 S.A.

leon.info
Class LyTabAction

java.lang.Object
  extended by leon.info.LyTag
      extended by leon.info.LyInfo
          extended by leon.info.LyObjectInfo
              extended by leon.info.LyAction
                  extended by leon.info.LyTabAction
All Implemented Interfaces:
java.lang.Cloneable, LyCommentInterface

public final class LyTabAction
extends LyAction

This class implements the description of tab actions : action containing a list of sub-actions. Tab actions are used to allow building of views presented as tabs. Sub-actions of a tab action can also be tab or tab actions this gives us the richness for building complex presentations.
This class extends LyAction : a tab action is an action and can be used everywhere actions are used.
The extra attributes on tab actions are the following :


Nested Class Summary
static class LyTabAction.Type
          Tab action types.
 
Nested classes/interfaces inherited from class leon.info.LyTag
LyTag.Model
 
Field Summary
static java.lang.String __VERSION
           
static short CONTEXT_ALL
          Context : both.
static short CONTEXT_NONE
          Context : none.
 
Fields inherited from class leon.info.LyAction
__version, ACTION_ID_SEP, ID_ACTIVATE, ID_CANVAS, ID_CHART, ID_CHART_FILE, ID_CHOOSE, ID_CLONE, ID_CONSULT, ID_CONSULT_RELATION_TABLE, ID_CONTEXT, ID_COPY, ID_CREATE, ID_CREATEWS, ID_DASHBOARD, ID_DATE_TOOL, ID_DELETE, ID_DELETE_CHART, ID_DELETEWS, ID_EXEC, ID_EXIT, ID_EXPORT, ID_EXPORT_PREVIEW, ID_FAST_FILTER, ID_GANTT, ID_HIDE, ID_IMPORT, ID_IMPORT_TABLE, ID_LOGIN, ID_MAIL, ID_MAP, ID_MODIFY, ID_MOVE_DOWN_TOOL, ID_MOVE_UP_TOOL, ID_MULTI_PAGE_TABLE, ID_NEW_FILTER, ID_NEXT_PAGE, ID_PASSWORD, ID_PASTE, ID_PREVIOUS_PAGE, ID_PRINT, ID_PRINT_TABLE, ID_REDO, ID_REPORTING, ID_SAVE_AS, ID_SELECT, ID_SELECT_BY_NAME, ID_SELECT_FILE, ID_SET, ID_SET_EMPTY, ID_SET_FILTER, ID_SET_RELATION_TABLE, ID_SETWS, ID_SHOW, ID_SORT_WIZARD, ID_START_MODULE, ID_TABLE, ID_TEXT, ID_TREE, ID_UNDO, ID_UPDATE_ARRAY_VALUE, ID_USER_INPUT, ID_WAITING_VIEW, ID_XREF, MARK_DEFAULT, MARK_DIALOG, MARK_FORM, MARK_FRAME_VIEW, MARK_HIDDEN, MARK_MOBILEONLY, MARK_MOBILEWEBVIEW, MARK_MODAL, MARK_NO_COMMANDS, MARK_NO_CONTEXT, MARK_NO_DECORATION, MARK_NO_MENU, MARK_NO_MENUBAR, MARK_NO_MESSAGES, MARK_NO_TABS, MARK_NO_TITLEBAR, MARK_NO_TOOLBAR, MARK_NOTFORMOBILE, MARK_POPUP, MARK_PORTLET, MARK_STATUS, MARK_TOOL, MARK_TRANSVERSE, MARK_WEBSERVICE, PARAM_CLASS, PARAM_FIELD, PARAM_FIELD_MARKS, PARAM_FILTER, PARAM_SORT
 
Fields inherited from class leon.info.LyObjectInfo
NULL, PART_ALL, PART_BIND, PART_DATA, PART_GUI, PART_LABEL
 
Constructor Summary
LyTabAction(java.lang.String id, LyAction template, java.lang.String controllerClassName, java.lang.String behaviorClassName, java.lang.String builderClassName, short clientContextIndex, java.lang.String target, LyTabAction.Type type)
          Constructor of a new tab action.
 
Method Summary
 java.lang.String getBehaviorClassName()
          Gets behavior class name.
 short getClientContextIndex()
          Specifies if the client context action is the action at the given index, none or all of them.
 LyAction getTabAction(int index)
          Gets sub-action at the given index in sub-actions list.
 int getTabActionCount()
          Gets number of sub-actions.
 LyInfoList<LyAction> getTabActions()
          Gets sub-actions list.
 LyTabAction.Type getType()
          Gets type of the tab action.
 boolean isViewable()
          Method used to check if this action is viewable or not.
 
Methods inherited from class leon.info.LyAction
canBeInvoked, free, getAction, getActionCount, getActions, getBehaviorClass, getBuilderClass, getBuilderClassName, getClassInfo, getControllerClass, getControllerClassName, getDefaultAction, getEnvironment, getFieldInfos, getFilter, getGenericMarks, getGeometry, getLyParameter, getMark, getMark, getMarkName, getMax, getMenu, getMin, getParameter, getParameter, getParameterDecl, getParameterMarks, getParameters, getParametersDecl, getResources, getRoot, getShortcut, getSpecificMarks, getTarget, getView, hasMark, isAbstract, isActionRef, setParentEnvironment
 
Methods inherited from class leon.info.LyObjectInfo
clone, getAlias, getData, getDataList, getDatas, getFilePrefix, getGroup, getInternalAlias, getInternalFilePrefix, getInternalName, getMarks, getName, getTemplate, getTip, getUserData, hasMark, hasMarks, hasTemplate, isTemplate, putData, putData, removeData, toName
 
Methods inherited from class leon.info.LyInfo
getApplication, getFile, getId, getInclude, isIncluded, isInternal, isInternal, isLoaded, isLocked, load, setApplication, setFile, toString
 
Methods inherited from class leon.info.LyTag
getCommentsEnd, getCommentsStart, getEnvironment, getModelType, getParent, getRootProject, hasAncestor, isExtern, setCommentsEnd, setCommentsStart, wasCloned
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait
 
Methods inherited from interface leon.parser.LyCommentInterface
getCommentsEnd, getCommentsStart, setCommentsEnd, setCommentsStart
 

Field Detail

__VERSION

public static final java.lang.String __VERSION
See Also:
Constant Field Values

CONTEXT_NONE

public static short CONTEXT_NONE
Context : none.


CONTEXT_ALL

public static short CONTEXT_ALL
Context : both.

Constructor Detail

LyTabAction

public LyTabAction(java.lang.String id,
                   LyAction template,
                   java.lang.String controllerClassName,
                   java.lang.String behaviorClassName,
                   java.lang.String builderClassName,
                   short clientContextIndex,
                   java.lang.String target,
                   LyTabAction.Type type)
Constructor of a new tab action.

Parameters:
id - Identifier of the tab action.
template - Reference of the action template.
controllerClassName - Java class name of the action controller.
behaviorClassName - Java class name of the action behavior.
builderClassName - Java class name of the action builder.
clientContextIndex - Client context index. Accepted values are : -2 = both, -1 = no context, 0 = context is given by first action, 1 = context is given by second action.
target - The target zone id for this action.
type - Type of the tab action.
Method Detail

getTabActions

public LyInfoList<LyAction> getTabActions()
Gets sub-actions list.

Returns:
List of these actions.

getTabAction

public LyAction getTabAction(int index)
Gets sub-action at the given index in sub-actions list.

Parameters:
index - Index of the searched sub-action.
Returns:
Sub-action at the given index, null if no sub-action is defined.

getTabActionCount

public int getTabActionCount()
Gets number of sub-actions.

Returns:
Number of sub-actions of this action.

getClientContextIndex

public short getClientContextIndex()
Specifies if the client context action is the action at the given index, none or all of them.

Returns:
the client context index

getType

public LyTabAction.Type getType()
Gets type of the tab action.

Returns:
The tab action type.

isViewable

public boolean isViewable()
Method used to check if this action is viewable or not.

Overrides:
isViewable in class LyAction
Returns:
True.

getBehaviorClassName

public java.lang.String getBehaviorClassName()
Gets behavior class name.

Overrides:
getBehaviorClassName in class LyAction
Returns:
Java name of behavior class (may be null).

(c) January 2013 - W4 S.A.

Website: W4 S.A., contact us: support@w4global.com