Class: NSValueTransformer

Inherits:
NSObject show all

Overview

NSValueTransformer is an abstract class that is used by the Cocoa Bindings technology to transform values from one representation to another.

Class Method Summary (collapse)

Instance Method Summary (collapse)

Methods inherited from NSObject

#!, #!=, #!~, #, #==, #===, #=~, #Rational, #__callee__, #__method__, #__send__, #__type__, `, alloc, allocWithZone:, #autoContentAccessingProxy, autoload, autoload?, autorelease_pool, #awakeAfterUsingCoder:, binding, block_given?, caller, cancelPreviousPerformRequestsWithTarget:, cancelPreviousPerformRequestsWithTarget:selector:object:, catch, class, classFallbacksForKeyedArchiver, #classForCoder, #classForKeyedArchiver, classForKeyedUnarchiver, #clone, conformsToProtocol:, #copy, copyWithZone:, #dealloc, #define_singleton_method, description, display, #doesNotRecognizeSelector:, #dup, #enum_for, #eql?, #equal?, #extend, fail, #finalize, format, #forwardInvocation:, #forwardingTargetForSelector:, framework, #freeze, #frozen?, getpass, gets, global_variables, #init, initialize, #initialize_clone, #initialize_copy, #initialize_dup, #inspect, instanceMethodForSelector:, instanceMethodSignatureForSelector:, #instance_eval, #instance_exec, #instance_of?, #instance_variable_defined?, #instance_variable_get, #instance_variable_set, #instance_variables, instancesRespondToSelector:, isSubclassOfClass:, #is_a?, iterator?, #kind_of?, lambda, load, load_bridge_support_file, load_plist, local_variables, loop, #method, #methodForSelector:, #methodSignatureForSelector:, #methods, #mutableCopy, mutableCopyWithZone:, new, #nil?, open, p, #performSelector:onThread:withObject:waitUntilDone:, #performSelector:onThread:withObject:waitUntilDone:modes:, #performSelector:withObject:afterDelay:, #performSelector:withObject:afterDelay:inModes:, #performSelectorInBackground:withObject:, #performSelectorOnMainThread:withObject:waitUntilDone:, #performSelectorOnMainThread:withObject:waitUntilDone:modes:, print, printf, #private_methods, proc, #protected_methods, #public_method, #public_methods, #public_send, putc, puts, raise, rand, readline, readlines, #replacementObjectForCoder:, #replacementObjectForKeyedArchiver:, require, resolveClassMethod:, resolveInstanceMethod:, #respond_to?, #respond_to_missing?, select, #send, setVersion:, #singleton_methods, sprintf, srand, superclass, #taint, #tainted?, #tap, test, throw, #to_plist, #to_s, trace_var, trap, #trust, #untaint, untrace_var, #untrust, #untrusted?, version

Constructor Details

This class inherits a constructor from NSObject

Dynamic Method Handling

This class handles dynamic methods through the method_missing method in the class NSObject

Class Method Details

+ (Boolean) allowsReverseTransformation

Returns a Boolean value that indicates whether the receiver can reverse a transformation. A subclass should override this method to return YES if it supports reverse value transformations.

Returns:

  • (Boolean)

    YES if the receiver supports reverse value transformations, otherwise NO.The default is NO.

+ (Object) setValueTransformer(transformer, forName:name)

Registers the provided value transformer with a given identifier.

Parameters:

Returns:

+ (Class) transformedValueClass

Returns the class of the value returned by the receiver for a forward transformation. A subclass should override this method to return the appropriate class.

Returns:

  • (Class)

    The class of the value returned by the receiver for a forward transformation.

+ (NSValueTransformer) valueTransformerForName(name)

Returns the value transformer identified by a given identifier. If valueTransformerForName: does not find a registered transformer instance for name, it will attempt to find a class with the specified name. If a corresponding class is found an instance will be created and initialized using its init: method and then automatically registered with name.

Parameters:

  • name (String)

    The transformer identifier.

Returns:

  • (NSValueTransformer)

    The value transformer identified by name in the shared registry, or nil if not found.

+ (Array) valueTransformerNames

Returns an array of all the registered value transformers.

Returns:

  • (Array)

    An array of all the registered value transformers.

Instance Method Details

- (Object) reverseTransformedValue(value)

Returns the result of the reverse transformation of a given value. The default implementation raises an exception if allowsReverseTransformation returns NO; otherwise it will invoke transformedValue: with value.A subclass should override this method if they require a reverse transformation that is not the same as simply reapplying the original transform (as would be the case with negation, for example). For example, if a value transformer converts a value in Fahrenheit to Celsius, this method would converts a value from Celsius to Fahrenheit.

Parameters:

  • value (Object)

    The value to reverse transform.

Returns:

  • (Object)

    The reverse transformation of value.

- (Object) transformedValue(value)

Returns the result of transforming a given value. A subclass should override this method to transform and return an object based on value.

Parameters:

  • value (Object)

    The value to transform.

Returns:

  • (Object)

    The result of transforming value.The default implementation simply returns value.