org.sandev.basics.structs
Class UIDisplayDirectiveStruct

java.lang.Object
  org.sandev.basics.structs.UIDisplayDirectiveStruct

Direct Known Subclasses:

UIDisplayDirective

public class UIDisplayDirectiveStruct
extends java.lang.Object

An instance of a user interface action to be tracked for the life of a form context. For example a user may choose to collapse a reference array to conserve screen real estate. That collapse is then tracked for the given instance for the duration of the time the user is working with the form, unless the reference array is expanded again by the application.

summary fields: className instanceID fieldName directive
help text: An instance of a user interface action to be tracked for the life of a form context.

Field Summary

protected java.lang.String	className The short class name of the message instance we are capturing a directive for.
protected int	directive The directive being captured.
protected java.lang.String	fieldName The name of the field within the message instance we are capturing a directive for.
protected java.lang.String	instanceID The unique identifier for the message instance we are capturing a directive for.

Constructor Summary

UIDisplayDirectiveStruct()

Method Summary

Methods inherited from class java.lang.Object

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

Field Detail

className

protected java.lang.String className

The short class name of the message instance we are capturing a directive for. The class name is necessary because in the UI it is possible to have different classes of objects with the same unique identifier. For example consider a custom UI shell object wrapping a persistent object where the same uniqueID is used to identify both instances in the UI.

instanceID

protected java.lang.String instanceID

The unique identifier for the message instance we are capturing a directive for. Typically this is the uniqueID for a persistent object, but may also be a unique name which is why it is represented as a string.

fieldName

protected java.lang.String fieldName

The name of the field within the message instance we are capturing a directive for.

directive

protected int directive

The directive being captured. Application specific directives should use values greater than RESERVEMAX. Removing a directive resets the display behavior to its default, which is equivalent to setting the directive to NONE.

enumerated constant values:

• NONE("None") = 0
  
• COLLAPSE("Collapse") = 1
  
• EXPAND("Expand") = 2
  
• RESERVEMAX("Reserve max") = 100
  

declared invalid value: -1

Constructor Detail

UIDisplayDirectiveStruct

public UIDisplayDirectiveStruct()