fr.paris.lutece.plugins.forms.util

Class FormsDisplayUtils

java.lang.Object

fr.paris.lutece.plugins.forms.util.FormsDisplayUtils

public final class FormsDisplayUtils
extends Object

Utility class for plugin Forms

Method Summary

Modifier and Type	Method and Description
static int	getDisplayDepthFromParent(int nParentDisplay) Returns the display depth of a child display element
static String	getDisplayTitle(FormDisplay formDisplayToMove) Utility Method to retrieve the Move composite page title from a given FormDisplay
static fr.paris.lutece.util.ReferenceList	getlistAvailablePositionsInGroup(int nIdStep, int nIdDisplayGroup, boolean bAddPosition, Locale locale) Return a ReferenceList containing all the available positions within a given parent FormDisplay, in a given Step.
static fr.paris.lutece.util.ReferenceList	getTargetGroupDisplayListByStep(int nIdStep, FormDisplay formDisplayToMove, Locale locale) Utility Method to retrieve referenceList containing all the Displays of a given Step that could be a potential destination parent for the given FormDisplay.
static boolean	isDescendantDisplay(int nDisplayId, FormDisplay formDisplay) Return true if the provided FormDisplay identifier A is a descendant (a child, grandchild, great-grandchild, etc.) of the second FormDisplay parameter

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

getTargetGroupDisplayListByStep

public static fr.paris.lutece.util.ReferenceList getTargetGroupDisplayListByStep(int nIdStep,
                                                                                 FormDisplay formDisplayToMove,
                                                                                 Locale locale)

Utility Method to retrieve referenceList containing all the Displays of a given Step that could be a potential destination parent for the given FormDisplay. The ReferenceList begins with a first root level item, followed by all the relevant children displays of type "Group". If the Display to be moved is a group, this Display and its child groups will be excluded from the list

Parameters:

nIdStep - The Step identifier

formDisplayToMove - The Display to move.

locale - The Locale

Returns:

a ReferenceList containing the Groups of the step

isDescendantDisplay

public static boolean isDescendantDisplay(int nDisplayId,
                                          FormDisplay formDisplay)

Return true if the provided FormDisplay identifier A is a descendant (a child, grandchild, great-grandchild, etc.) of the second FormDisplay parameter

Parameters:

nDisplayId - the FormDisplay identifier A

formDisplay - the FormDisplay B

Returns:

true if A is a descendant of B

getDisplayTitle

public static String getDisplayTitle(FormDisplay formDisplayToMove)

Utility Method to retrieve the Move composite page title from a given FormDisplay

Parameters:

formDisplayToMove - the FormDisplay

Returns:

the admin page title

getlistAvailablePositionsInGroup

public static fr.paris.lutece.util.ReferenceList getlistAvailablePositionsInGroup(int nIdStep,
                                                                                  int nIdDisplayGroup,
                                                                                  boolean bAddPosition,
                                                                                  Locale locale)

Return a ReferenceList containing all the available positions within a given parent FormDisplay, in a given Step. Includes the position after the last element of the group.

Parameters:

nIdStep - the identifier of the Step

nIdDisplayGroup - the identifier of the group DIsplay parent. Zero for the step root level

bAddPosition - if true a position is added at the end of the list

locale - The locale

Returns:

the available positions sorted in a ReferenceList

getDisplayDepthFromParent

public static int getDisplayDepthFromParent(int nParentDisplay)

Returns the display depth of a child display element

Parameters:

nParentDisplay - the Identifier of the parent display element (zero if we are at the step root)

Returns:

the display depth