LEONARDI Application Composer - 8.9.0.40 by W4 S.A.

leon.info
Class LyCompoundAction

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.LyCompoundAction
All Implemented Interfaces:
java.lang.Cloneable, LyCommentInterface

public final class LyCompoundAction
extends LyAction

This class implements the description of compound actions : action composed of 2 sub-actions. Compound actions are used to allow building of composite views (views composed of sub-views). Sub-actions of a compound action can also be compound actions this gives us the richness for building complex presentations.
This class extends LyAction : a compound action is an action and can be used everywhere actions are used.
The extra attributes on compound actions are the following :


Nested Class Summary
static class LyCompoundAction.ClientContext
           
static class LyCompoundAction.Context
           
static class LyCompoundAction.Style
          Presentation styles .
 
Nested classes/interfaces inherited from class leon.info.LyTag
LyTag.Model
 
Field Summary
static java.lang.String __version
           
 
Fields inherited from class leon.info.LyAction
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
__VERSION, NULL, PART_ALL, PART_BIND, PART_DATA, PART_GUI, PART_LABEL
 
Constructor Summary
LyCompoundAction(LyAction xrefAction)
          Constructor of a compound action for a xref action.
LyCompoundAction(LyAction template, java.util.Hashtable<java.lang.String,java.lang.Object> parameters)
          Constructs a new compound action.
 
Method Summary
 LyCompoundAction.ClientContext getClientContext()
          Specifies if the client context action is the first action, the second one, none or both of them.
 short getClientContextIndex()
          Specifies if the client context action is the first action, the second one, none or both of them.
 LyCompoundAction.Context getContext()
          Specifies if the context action is the first the second or none.
 LyAction getContextAction()
          Specifies which action is used as context for the other one (selections on the view of the context action cause the other view to be refreshed).
 short getContextIndex()
          Specifies if the context action is the first the second or none.
 LyAction getFirstAction()
          Gets first sub-action of this compound action.
 int[] getIntSizes()
          Gets ratios attributed to each sub-action view.
 LyAction getSecondAction()
          Gets second sub-action of this compound action.
 java.lang.String getSizes()
          Gets ratios attributed to each sub-action view.
 LyCompoundAction.Style getStyle()
          Gets presentation style which defines how sub-actions views are presented.
 LyAction getSubAction(int index)
          Gets sub-action at the given index in sub-actions list.
 int getSubActionCount()
          Gets number of sub-actions.
 LyInfoList<LyAction> getSubActions()
          Gets sub-actions list.
 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, getBehaviorClassName, 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
Constructor Detail

LyCompoundAction

public LyCompoundAction(LyAction xrefAction)
Constructor of a compound action for a xref action.

Parameters:
xrefAction - XRef action.

LyCompoundAction

public LyCompoundAction(LyAction template,
                        java.util.Hashtable<java.lang.String,java.lang.Object> parameters)
Constructs a new compound action.

Parameters:
template - Action template.
parameters - Action parameters.
Method Detail

getFirstAction

public LyAction getFirstAction()
Gets first sub-action of this compound action.

Returns:
The first action contained in this compound action.

getSecondAction

public LyAction getSecondAction()
Gets second sub-action of this compound action.

Returns:
The second action contained in this compound action.

getStyle

public LyCompoundAction.Style getStyle()
Gets presentation style which defines how sub-actions views are presented.

Returns:
Presentation style of this compound action. Supported values are defined as public static and named Style.XXX.

getSizes

public java.lang.String getSizes()
Gets ratios attributed to each sub-action view. This is a string contained numbers that give a weight on each of sub-views (for example "30 70" gives 30% to the first sub-action view, 70% to the second one).

Returns:
Relative sizes of each sub-action view.

getIntSizes

public int[] getIntSizes()
Gets ratios attributed to each sub-action view. This is a string contained numbers that give a weight on each of sub-views (for example "30 70" gives 30% to the first sub-action view, 70% to the second one).

Returns:
Relative sizes of each sub-action view.

getContextAction

public LyAction getContextAction()
Specifies which action is used as context for the other one (selections on the view of the context action cause the other view to be refreshed).

Returns:
The first action, the second action or null.

getContextIndex

public short getContextIndex()
Specifies if the context action is the first the second or none.

Returns:
the context index; NONE if compound action has style GRID

getContext

public LyCompoundAction.Context getContext()
Specifies if the context action is the first the second or none.

Returns:
the context index; NONE if compound action has style GRID

getClientContextIndex

public short getClientContextIndex()
Specifies if the client context action is the first action, the second one, none or both of them.

Returns:
the client context index

getClientContext

public LyCompoundAction.ClientContext getClientContext()
Specifies if the client context action is the first action, the second one, none or both of them.

Returns:
the client context index

getSubActions

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

Returns:
List of these actions.

getSubAction

public LyAction getSubAction(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.

getSubActionCount

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

Returns:
Number of sub-actions of this action.

isViewable

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

Overrides:
isViewable in class LyAction
Returns:
True.

(c) January 2013 - W4 S.A.

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