EOXMLUnarchiver

Inherits from:
Object

Package:
com.webobjects.eoapplication

Class Description

EOXMLUnarchiver objects contain the parameters used to create controllers (objects of the EOController class and its descendents) in the controller hierarchy. The parameters are determined from an XML specification sent from server.

For more information on using this class, see the book Getting Started with Direct to Java Client.

Constants

EOXMLUnarchiver defines the following String constants:

Constant	Description
`ActionKeyParameter`
`ActionNameParameter`
`ActionPriorityParameter`
`ActionWidgetPositionParameter`
`AlignmentParameter`
`AlignmentWidthParameter`
`AlignsComponentsParameter`
`AllowsMultipleSelectionParameter`
`ArchiveNameParameter`
`BorderTypeParameter`
`ButtonPositionParameter`
`CategoryNameParameter`
`CategoryPriorityParameter`
`ClassNameParameter`
`ColorParameter`
`DescriptionPathParameter`
`DisabledActionNamesParameter`
`DisplayGroupProviderMethodNameParameter`
`DisplaysLabelInWidgetParameter`
`DisposeIfDeactivatedParameter`
`EditabilityParameter`
`EditingContextProviderMethodNameParameter`
`EnabledDisplayGroupProviderMethodNameParameter`
`EnabledKeyParameter`
`EntityParameter`
`FontParameter`
`FormatAllowedParameter`
`FormatClassParameter`
`FormatPatternParameter`
`HighlightParameter`
`HorizontalBorderParameter`
`HorizontallyResizableParameter`
`IconNameParameter`
`IconURLParameter`
`ImageScalingParameter`
`IsQueryWidgetParameter`
`LabelAlignmentParameter`
`LabelComponentPositionParameter`
`LabelParameter`
`MandatoryRelationshipPathsParameter`
`MaximumValueKeyParameter`
`MenuAcceleratorParameter`
`MinimumHeightParameter`
`MinimumValueKeyParameter`
`MinimumWidthParameter`
`MultipleWindowsAvailableParameter`
`PrefersIconOnlyParameter`
`QuickTimeCanvasResizingParameter`
`RelationshipPathParameter`
`ScalingHintsParameter`
`SendsActionToAllControllersParameter`
`SharedIdentifierParameter`
`ShortDescriptionParameter`
`SmallIconNameParameter`
`SmallIconURLParameter`
`SortsByColumnOrderParameter`
`TaskParameter`
`TitleKeysParameter`
`TitlePositionParameter`
`TitlesDisplayGroupProviderMethodNameParameter`
`TitlesEntityParameter`
`TypeNameParameter`
`URLKeyParameter`
`UsesActionParameter`
`UsesButtonParameter`
`UsesHorizontalLayoutParameter`
`UsesLabelComponentParameter`
`UsesLargeButtonRepresentationParameter`
`UsesTitledBorderParameter`
`UsesUserDefaultsWindowLocationParameter`
`UsesUserDefaultsWindowSizeParameter`
`ValueKeyParameter`
`VerticalBorderParameter`
`VerticallyResizableParameter`
`WindowPositionParameter`

Method Types

Decoding objects
decodeAlignmentForKey
decodeArrayForKey
decodeBooleanForKey
decodeClassForKey
decodeColorForKey
decodeDictionaryForKey
decodeEditabilityForKey
decodeFontForKey
decodeIntForKey
decodePositionForKey
decodeStringForKey
decodeValueForKey
Other methods
EOXMLUnarchiver
decodeRootObject
decodeChildren

Constructors

EOXMLUnarchiver

public EOXMLUnarchiver(NSDictionary values)

Creates an XML archiver based on the values NSDictionary.

Static Methods

decodeRootObject

public static Object decodeRootObject(NSDictionary aNSDictionary)

Decodes the top controller in an XML description, which is represented by an NSDictionary.

Instance Methods

decodeAlignmentForKey

public int decodeAlignmentForKey( String key, int defaultAlignment)

Returns an alignment specification (JTextField.LEFT, JTextField.CENTER, or JTextField.RIGHT) for the key XML attribute. If no value for key is specified, returns defaultAlignment.

public int decodeAlignmentForKey(String key)

Returns an alignment specification (JTextField.LEFT, JTextField.CENTER, or JTextField.RIGHT) for the key XML attribute. If no value for key is specified, returns JTextField.LEFT.

decodeArrayForKey

public NSArray decodeArrayForKey( String key, NSArray defaultArray)

Returns an NSArray for the key XML attribute. If no value for key is specified, returns defaultArray.

public NSArray decodeArrayForKey(String key)

Returns an NSArray for the key XML attribute. If no value for key is specified, returns null.

decodeBooleanForKey

public boolean decodeBooleanForKey( String key, boolean defaultBoolean)

Returns a boolean for the key XML attribute. If no value for key is specified, returns defaultBoolean.

public boolean decodeBooleanForKey(String key)

Returns a boolean for key XML attribute. If no value for key is specified, returns false.

decodeChildren

public NSArray decodeChildren()

Returns an NSArray containing the receiver's decoded children. The children are the objects created from XML tags contained in the receiver's XML description.

decodeClassForKey

public Class decodeClassForKey( String key, Class defaultClass)

Returns a Class for the key XML attribute. If no value for key is specified, returns defaultClass.

public Class decodeClassForKey(String key)

Returns a Class for the key XML attribute. If no value for key is specified, returns null.

decodeColorForKey

public java.awt.Color decodeColorForKey( String key, java.awt.Color defaultColor)

Returns a color (a java.awt.Color object) for the key XML attribute. If no value for key is specified, returns defaultColor.

public java.awt.Color decodeColorForKey(String key)

Returns a color (a java.awt.Color object) for the key XML attribute. If no value for key is specified, returns null.

decodeDictionaryForKey

public NSDictionary decodeDictionaryForKey( String key, NSDictionary defaultDictionary)

Returns a NSDictionary for the key XML attribute. If no value for key is specified, returns defaultDictionary.

public NSDictionary decodeDictionaryForKey(String key)

Returns a NSDictionary for the key XML attribute. If no value for key is specified, returns null.

decodeEditabilityForKey

public int decodeEditabilityForKey( String key, int defaultEditability)

Returns an editability specification (EOEditable.IfSupercontrollerEditable, EOEditable.AlwaysEditable, or EOEditable.NeverEditable) for the key XML attribute. If no value for key is specified, returns defaultEditibility.

public int decodeEditabilityForKey(String key)

decodeFontForKey

public java.awt.Font decodeFontForKey( String key, java.awt.Font defaultFont)

Returns a font specification (a java.awt.Font object) for the key XML attribute. If no value for key is specified, returns defaultFont.

public java.awt.Font decodeFontForKey(String key)

Returns a font specification (a java.awt.Font object) for the key XML attribute. If no value for key is specified, returns null.

decodeIntForKey

public int decodeIntForKey( String key, int defaultInt)

Returns an int for the key XML attribute. If no value for key is specified, returns defaultInt.

public int decodeIntForKey(String key)

Returns an int for the key XML attribute. If no value for key is specified, returns 0.

decodePositionForKey

public int decodePositionForKey( String key, int defaultPosition)

Returns a position specification (EOComponentController.Top, EOComponentController.Bottom, EOComponentController.Left, EOComponentController.Right, EOComponentController.TopLeft, EOComponentController.TopRight, EOComponentController.BottomLeft, or EOComponentController.BottomRight) for the key XML attribute. If no value for key is specified, returns defaultPosition.

public int decodePositionForKey(String key)

decodeStringForKey

public String decodeStringForKey( String key, String defaultString)

Returns a String for the key XML attribute. If no value for key is specified, returns defaultString.

public String decodeStringForKey(String key)

Returns a String for the key XML attribute. If no value for key is specified, returns null.

decodeValueForKey

public Object decodeValueForKey(String key)

Returns an Object for the key XML attribute. If no value for key is specified, returns null.