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 by
FormEnvironment.getFormComponentTree().-
Method Summary
Modifier and TypeMethodDescriptionList<?> Get the children of this layout group.Returns the type of the layout groupgetId()Get the ID that the framework associates with this layout group.booleanReturns whether the layout group is visible or not.voidsetEnabled(boolean enabled) Sets whether contained form components are enabled or not.voidsetVisible(boolean visible) Sets whether the layout group is visible or not.
-
Method Details
-
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
isVisiblemethod, because the state of the contained form components may be mixed.- Parameters:
visible- whether this layout group should be visible or not- See Also:
-
isVisible
boolean isVisible()Returns whether the layout group is visible or not.- Returns:
trueorfalse.- See Also:
-
getId
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
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
-