Package com.install4j.api.formcomponents
Interface LayoutGroup
-
public interface LayoutGroup
Represents a layout group for form components. Instances of this interface are contained in the list that is returned byFormEnvironment.getFormComponentTree()
.
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description java.util.List<?>
getChildren()
Get the children of this layout group.GroupType
getGroupType()
Returns the type of the layout groupjava.lang.String
getId()
Get the ID that the framework associates with this layout group.boolean
isVisible()
Returns whether the layout group is visible or not.void
setEnabled(boolean enabled)
Sets whether contained form components are enabled or not.void
setVisible(boolean visible)
Sets whether the layout group is visible or not.
-
-
-
Method Detail
-
getGroupType
GroupType getGroupType()
Returns the type of the layout group- Returns:
- the type
-
setEnabled
void setEnabled(boolean enabled)
Sets whether contained form components are enabled or not. SeeFormComponent.setEnabled(boolean)
for more information. All descendant form components are affected.- Parameters:
enabled
- whether to enable the descendant form components or not
-
setVisible
void setVisible(boolean visible)
Sets whether the layout group is visible or not.There is no corresponding
isVisible
method, because the state of the contained form components may be mixed.- Parameters:
visible
- whether this layout group should be visible or not- See Also:
FormComponent.setVisible(boolean)
,isVisible()
-
isVisible
boolean isVisible()
Returns whether the layout group is visible or not.- Returns:
true
orfalse
.- See Also:
setVisible(boolean)
-
getId
java.lang.String getId()
Get the ID that the framework associates with this layout group. You can get layout groups by ID withFormEnvironment.getLayoutGroupById(String)
.- Returns:
- the ID
-
getChildren
java.util.List<?> getChildren()
Get the children of this layout group. The returned list has contents of the same form asFormEnvironment.getFormComponentTree()
.- Returns:
- a list with the next level of form components and layout groups that are children of this layout group
-
-