Package | mx.utils |
Class | public class Base64Encoder |
Inheritance | Base64Encoder ![]() |
Property | Defined By | ||
---|---|---|---|
![]() | constructor : Object
A reference to the class object or constructor function for a given object instance. | Object | |
insertNewLines : Boolean = true
A Boolean flag to control whether the sequence of characters specified
for Base64Encoder.newLine are inserted every 76 characters
to wrap the encoded output. | Base64Encoder | ||
newLine : int = 10 [static]
The character codepoint to be inserted into the encoded output to
denote a new line if insertNewLines is true. | Base64Encoder | ||
![]() | prototype : Object [static]
A reference to the prototype object of a class or function object. | Object |
Method | Defined By | ||
---|---|---|---|
Constructor. | Base64Encoder | ||
Encodes the characters of a String in Base64 and adds the result to
an internal buffer. | Base64Encoder | ||
Encodes a ByteArray in Base64 and adds the result to an internal buffer. | Base64Encoder | ||
Encodes the UTF-8 bytes of a String in Base64 and adds the result to an
internal buffer. | Base64Encoder | ||
![]() |
Indicates whether an object has a specified property defined. | Object | |
![]() |
Indicates whether an instance of the Object class is in the prototype chain of the object specified
as the parameter. | Object | |
![]() |
Indicates whether the specified property exists and is enumerable. | Object | |
Clears all buffers and resets the encoder to its initial state. | Base64Encoder | ||
![]() |
Sets the availability of a dynamic property for loop operations. | Object | |
![]() |
Returns the string representation of this object, formatted according to locale-specific conventions. | Object | |
Returns the current buffer as a Base64 encoded String. | Base64Encoder | ||
![]() |
Returns the primitive value of the specified object. | Object |
Constant | Defined By | ||
---|---|---|---|
CHARSET_UTF_8 : String = "UTF-8" [static] | Base64Encoder |
insertNewLines | property |
public var insertNewLines:Boolean = true
A Boolean flag to control whether the sequence of characters specified
for Base64Encoder.newLine
are inserted every 76 characters
to wrap the encoded output.
The default is true.
newLine | property |
public static var newLine:int = 10
The character codepoint to be inserted into the encoded output to
denote a new line if insertNewLines
is true.
The default is 10
to represent the line feed \n
.
Base64Encoder | () | Constructor |
public function Base64Encoder()
Constructor.
encode | () | method |
public function encode(data:String, offset:uint = 0, length:uint = 0):void
Encodes the characters of a String in Base64 and adds the result to
an internal buffer. Subsequent calls to this method add on to the
internal buffer. After all data have been encoded, call
toString()
to obtain a Base64 encoded String.
Parameters
data:String — The String to encode.
| |
offset:uint (default = 0 ) — The character position from which to start encoding.
| |
length:uint (default = 0 ) — The number of characters to encode from the offset.
|
encodeBytes | () | method |
public function encodeBytes(data:ByteArray, offset:uint = 0, length:uint = 0):void
Encodes a ByteArray in Base64 and adds the result to an internal buffer.
Subsequent calls to this method add on to the internal buffer. After all
data have been encoded, call toString()
to obtain a
Base64 encoded String.
Parameters
data:ByteArray — The ByteArray to encode.
| |
offset:uint (default = 0 ) — The index from which to start encoding.
| |
length:uint (default = 0 ) — The number of bytes to encode from the offset.
|
encodeUTFBytes | () | method |
public function encodeUTFBytes(data:String):void
Encodes the UTF-8 bytes of a String in Base64 and adds the result to an
internal buffer. The UTF-8 information does not contain a length prefix.
Subsequent calls to this method add on to the internal buffer. After all
data have been encoded, call toString()
to obtain a Base64
encoded String.
Parameters
data:String — The String to encode.
|
reset | () | method |
public function reset():void
Clears all buffers and resets the encoder to its initial state.
toString | () | method |
public function toString():String
Returns the current buffer as a Base64 encoded String. Note that calling this method also clears the buffer and resets the encoder to its initial state.
ReturnsString — The Base64 encoded String.
|
CHARSET_UTF_8 | Constant |
public static const CHARSET_UTF_8:String = "UTF-8"