JClass DesktopViews 6.3.0 API
Documentation

com.klg.jclass.util.swing.encode
Class JCEncodeComponent.Encoding

java.lang.Object
  |
  +--com.klg.jclass.util.swing.encode.JCEncodeComponent.Encoding
Enclosing class:
JCEncodeComponent

public static class JCEncodeComponent.Encoding
extends Object

Class used to enumerate valid encoding formats.


Constructor Summary
JCEncodeComponent.Encoding(String short_name, String long_name, String encoder_class, String failure_message)
          Constructs a new image encoder.
 
Method Summary
 com.klg.jclass.util.swing.encode.Encoder getEncoder()
          Returns an encoder for this encoding type.
 String getFailureMessage()
          Returns message about possible reasons for encoder load failure.
 String getLongName()
          Returns the long name of the supported encoding type.
 String getShortName()
          Returns the brief name of the supported encoding type.
 String toString()
          Returns a String representation bassed on the long and short name of the Encoder.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

JCEncodeComponent.Encoding

public JCEncodeComponent.Encoding(String short_name,
                                  String long_name,
                                  String encoder_class,
                                  String failure_message)
Constructs a new image encoder.

Parameters:
short_name -
long_name -
failure_message -
encoder_class -
Method Detail

getShortName

public String getShortName()
Returns the brief name of the supported encoding type.

Returns:
brief name of the supported encoding type

getLongName

public String getLongName()
Returns the long name of the supported encoding type.

Returns:
long name of the supported encoding type

toString

public String toString()
Returns a String representation bassed on the long and short name of the Encoder.

Overrides:
toString in class Object
Returns:
String representation based on the long and short name of the Encoder

getFailureMessage

public String getFailureMessage()
Returns message about possible reasons for encoder load failure. (For example, when getEncoder() returns null.)

Returns:
message about possible reasons for encoder load failure

getEncoder

public com.klg.jclass.util.swing.encode.Encoder getEncoder()
Returns an encoder for this encoding type.

Returns:
returns null if it cannot locate or load the encoder

Copyright © 2004 Quest Software Inc..
All rights reserved.