net.sf.mmm.client.ui.api.attribute

Interface AttributeReadFlagAdvanced

All Superinterfaces:

AttributeReadFlag

All Known Subinterfaces:

AttributeWriteFlagAdvanced

All Known Implementing Classes:

AbstractFlagAdvanced, AbstractUiWidgetNative.VisibleFlag

public interface AttributeReadFlagAdvanced
extends AttributeReadFlag

This interface gives advanced read access to a generic flag.

Since:

1.0.0

Author:

Joerg Hohwiller (hohwille at users.sourceforge.net)

See Also:

AttributeWriteVisible, AttributeWriteEnabled

Method Summary

Modifier and Type	Method and Description
boolean	getFlag() This method reads the flag value.
boolean	getFlag(FlagModifier modifier) This method gets the value of the flag for the given FlagModifier.

Method Detail

getFlag

boolean getFlag()

This method reads the flag value. This is a generic attribute. The meaning of the flag needs to be defined by the JavaDoc of the accessor to get the flag instance.
NOTE:
This method determines if the flag is true for all FlagModifiers.

Specified by:

getFlag in interface AttributeReadFlag

Returns:

true if all aggregated flags are true and all parents have the same flag set to true.

getFlag

boolean getFlag(FlagModifier modifier)

This method gets the value of the flag for the given FlagModifier.

Parameters:

modifier - is the FlagModifier. May be null for the default modifier.

Returns:

the flag for the given FlagModifier. Will be true if it has never been set for the given FlagModifier.