LEONARDI Application Composer - 8.9.0.40 by W4 S.A.

leon.info
Class LyChoiceOptionGroup

java.lang.Object
  extended by leon.info.LyTag
      extended by leon.info.LyInfo
          extended by leon.info.LyChoiceOptionGroup
All Implemented Interfaces:
java.lang.Cloneable, LyChoiceItem, LyCommentInterface

public final class LyChoiceOptionGroup
extends LyInfo
implements LyChoiceItem

This class implements the description of a group of choice options. A choice options group contains choice options that are either choice options or other groups.


Nested Class Summary
 
Nested classes/interfaces inherited from class leon.info.LyTag
LyTag.Model
 
Field Summary
static java.lang.String __version
           
 
Fields inherited from class leon.info.LyInfo
__VERSION
 
Method Summary
 boolean contains(LyChoiceItem item, boolean godown)
          Utility method to check if this group contains the given choice item.
 java.lang.String getAlias()
          Accessor for alias (shortname) of this instance.
 LyChoiceItem getChoiceItem(short index)
          Gets an item from the options group at a given position.
 short getChoiceItemCount()
          Gets options count.
 LyInfoList<LyInfo> getChoiceItems()
          Returns the list of options available on this options group.
 LyInfoList<LyChoiceOptionGroup> getChoiceOptionGroups(boolean godown)
          Utility method to retrieve options group of this choice field.
 LyInfoList<LyChoiceOption> getChoiceOptions(boolean godown)
          Returns the list of options available on this options group.
 java.lang.String getInternalAlias()
          Accessor for alias (shortname) of this instance.
 LyInfoLabel getLabel(int index)
          Returns the label of this group at the given index.
 LyInfoLabel getLabel(LyInfoLabel.Type type)
          Returns the the label of this group for the specified type.
 int getLabelCount()
          Returns the number of labels of this group.
 java.lang.String getName()
          Accessor to the name of this options group.
 LyChoiceOption getOption()
          Get the context option for this group.
 short getShortValue()
          Gets the short value corresponding to the internal value.
 java.lang.String getTip()
          Accessor to the tip of this options group.
 LyInfoLabel getUserLabel(int i)
          Returns the user label at the given position.
 LyInfoLabel getUserLabel(java.lang.String subType)
          Returns the user label for the given subType.
 int getUserLabelCount()
          Returns the number of labels of this group.
 java.lang.Object getValue()
          Accessor to the value of this options group.
 
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
clone, 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.info.LyChoiceItem
getId
 
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
Method Detail

getName

public java.lang.String getName()
Accessor to the name of this options group.

Specified by:
getName in interface LyChoiceItem
Overrides:
getName in class LyInfo
Returns:
Name of this options group.

getAlias

public java.lang.String getAlias()
Accessor for alias (shortname) of this instance.

Specified by:
getAlias in interface LyChoiceItem
Overrides:
getAlias in class LyInfo
Returns:
Alias of this instance. If the alias is null, this method returns the name.

getInternalAlias

public final java.lang.String getInternalAlias()
Accessor for alias (shortname) of this instance. This method doesn't compute a value if it is null

Returns:
Alias of this instance.

getTip

public java.lang.String getTip()
Accessor to the tip of this options group.

Returns:
Tip of this options group.

getChoiceItem

public LyChoiceItem getChoiceItem(short index)
Gets an item from the options group at a given position.

Parameters:
index - Index of the searched item.
Returns:
The item found, null otherwise.

getChoiceItemCount

public short getChoiceItemCount()
Gets options count.

Returns:
Return the number of options in this options group.

getChoiceItems

public LyInfoList<LyInfo> getChoiceItems()
Returns the list of options available on this options group.

Returns:
List of options of this options group.

getChoiceOptions

public LyInfoList<LyChoiceOption> getChoiceOptions(boolean godown)
Returns the list of options available on this options group.

Returns:
List of options of this options.

getChoiceOptionGroups

public LyInfoList<LyChoiceOptionGroup> getChoiceOptionGroups(boolean godown)
Utility method to retrieve options group of this choice field.

Returns:
List of options group.

getOption

public LyChoiceOption getOption()
Get the context option for this group.

Returns:
the context option for this group

contains

public boolean contains(LyChoiceItem item,
                        boolean godown)
Utility method to check if this group contains the given choice item.

Parameters:
choiceItem - searched choice item.
Returns:
True if contained, false otherwise.

getValue

public java.lang.Object getValue()
Accessor to the value of this options group.

Specified by:
getValue in interface LyChoiceItem
Returns:
Value of this options group.

getShortValue

public short getShortValue()
Gets the short value corresponding to the internal value. Used to optimize processings when internal values are shorts.

Specified by:
getShortValue in interface LyChoiceItem
Returns:
Short value corresponding to this group, 1 if value can't be casted to a short.

getLabelCount

public int getLabelCount()
Returns the number of labels of this group.


getLabel

public LyInfoLabel getLabel(LyInfoLabel.Type type)
Returns the the label of this group for the specified type.


getLabel

public LyInfoLabel getLabel(int index)
Returns the label of this group at the given index.


getUserLabelCount

public int getUserLabelCount()
Returns the number of labels of this group.


getUserLabel

public LyInfoLabel getUserLabel(int i)
Returns the user label at the given position.


getUserLabel

public LyInfoLabel getUserLabel(java.lang.String subType)
Returns the user label for the given subType.


(c) January 2013 - W4 S.A.

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