oracle.cabo.share.agent
Interface Agent

public interface Agent

The agent interface defines the end device that will display the rendering.

The set of capabilities and their interpretation is still in flux and subject to change.

Field Summary

static int	APPLICATION_ICE Application constant for the ICE Browser
static int	APPLICATION_IEXPLORER Application constant for the Microsoft Internet Explorer browser.
static int	APPLICATION_MOZILLA Application constant for the Mozilla browser, or browsers based on it (like Netscape 6).
static int	APPLICATION_NETSCAPE Application constant for the Netscape Navigator browser.
static int	APPLICATION_PIXO Application constant for the Pixo Microbrowser
static int	APPLICATION_PTG Application constant for iAS wireless (PTG) client
static int	APPLICATION_SIMPLE_RESULT Application constant for SimpleResult intermediate Form
static int	APPLICATION_UNKNOWN Application constant for an entirely unknown application.
static int	APPLICATION_WEB_CLIPPING Application constant for Palm Web Clippings
static int	APPLICATION_WML Application constant for a WML Microbrowser
static AgentCapabilityKey	CAP_ACCESS_KEYS
static AgentCapabilityKey	CAP_ADVANCED_BUTTONS
static AgentCapabilityKey	CAP_ADVANCED_FORMS
static AgentCapabilityKey	CAP_ALT_RENDERS_TOOLTIP_ON_IMAGE true if the alt key renders a tooltip for an image
static AgentCapabilityKey	CAP_DISABLED_FORM_ELEMENTS
static AgentCapabilityKey	CAP_DOM
static AgentCapabilityKey	CAP_EDITING
static AgentCapabilityKey	CAP_FRAMES
static AgentCapabilityKey	CAP_HEIGHT
static AgentCapabilityKey	CAP_ID
static AgentCapabilityKey	CAP_IFRAMES
static AgentCapabilityKey	CAP_IMAGE_ENCODINGS Agent capability which identifies the set of image encodings supported by this Agent.
static AgentCapabilityKey	CAP_INTRINSIC_EVENTS
static AgentCapabilityKey	CAP_MULTIPLE_WINDOWS true if multiple windows can be opened
static AgentCapabilityKey	CAP_NAME_IDENTIFICATION
static AgentCapabilityKey	CAP_NAVIGATION
static AgentCapabilityKey	CAP_NEEDS_CELL_PLACEHOLDERS True if the agent needs a placeholder to render an empty cell
static AgentCapabilityKey	CAP_PARTIAL_RENDERING
static AgentCapabilityKey	CAP_READONLY_FORM_ELEMENTS
static AgentCapabilityKey	CAP_SCRIPTING_SPEED
static AgentCapabilityKey	CAP_STYLE_ATTRIBUTES
static AgentCapabilityKey	CAP_TABLES
static AgentCapabilityKey	CAP_TARGET
static AgentCapabilityKey	CAP_TEXT_PRESENTATION
static AgentCapabilityKey	CAP_VALIGN true if supports vertical alignment
static AgentCapabilityKey	CAP_WIDTH
static java.lang.Object	DOM_CAP_FORM
static java.lang.Object	DOM_CAP_LEVEL_1
static java.lang.Object	DOM_CAP_LEVEL_2
static java.lang.Object	DOM_CAP_NONE
static int	IMAGE_ENCODINGS_CAP_BMP
static int	IMAGE_ENCODINGS_CAP_GIF
static int	IMAGE_ENCODINGS_CAP_JPEG
static int	IMAGE_ENCODINGS_CAP_PNG
static int	IMAGE_ENCODINGS_CAP_TRANSPARENT_PNG
static int	OS_LINUX OS constant for any Linux version.
static int	OS_MACOS OS constant for Apple MacOS.
static int	OS_PALM OS constant for any Palm version.
static int	OS_SOLARIS OS constant for any Solaris version.
static int	OS_UNKNOWN OS constant for an unknown operating system.
static int	OS_WINDOWS OS constant for any Microsoft Windows version.
static java.lang.Object	SCRIPTING_SPEED_CAP_FAST
static java.lang.Object	SCRIPTING_SPEED_CAP_NONE
static java.lang.Object	SCRIPTING_SPEED_CAP_SLOW
static java.lang.Object	STYLES_EXTERNAL
static java.lang.Object	STYLES_INTERNAL
static java.lang.Object	STYLES_NONE
static java.lang.Object	TABLES_CAP_ADVANCED
static java.lang.Object	TABLES_CAP_ADVANCED_ATTRS
static java.lang.Object	TABLES_CAP_BASIC
static int	TYPE_BROWSER Deprecated. Do not use this attribute
static int	TYPE_DESKTOP Application constant for Desktop devices
static int	TYPE_PDA Application constant for Palm-sized devices.
static int	TYPE_PHONE Application constant for Phone-sized devices
static int	TYPE_VOICE Application constant for voice

Method Summary

java.lang.String	exportAgent() Serializes the Agent into a String for later deserialization.
int	getAgentApplication() Returns the specific application to which we're rendering.
int	getAgentMajorVersion() Returns the major version number of the application, or 0 if a version number couldn't be identified.
int	getAgentOS() Returns the client operating system.
int	getAgentType() Returns the type of agent to which we're rendering.
java.lang.String	getAgentVersion() Returns the full, unparsed version string.
java.lang.Object	getCapability(AgentCapabilityKey key) Returns a capability of an Agent

Field Detail

CAP_DOM

public static final AgentCapabilityKey CAP_DOM

CAP_ID

public static final AgentCapabilityKey CAP_ID

CAP_ACCESS_KEYS

public static final AgentCapabilityKey CAP_ACCESS_KEYS

CAP_PARTIAL_RENDERING

public static final AgentCapabilityKey CAP_PARTIAL_RENDERING

CAP_DISABLED_FORM_ELEMENTS

public static final AgentCapabilityKey CAP_DISABLED_FORM_ELEMENTS

CAP_READONLY_FORM_ELEMENTS

public static final AgentCapabilityKey CAP_READONLY_FORM_ELEMENTS

CAP_ADVANCED_BUTTONS

public static final AgentCapabilityKey CAP_ADVANCED_BUTTONS

CAP_WIDTH

public static final AgentCapabilityKey CAP_WIDTH

CAP_HEIGHT

public static final AgentCapabilityKey CAP_HEIGHT

CAP_TEXT_PRESENTATION

public static final AgentCapabilityKey CAP_TEXT_PRESENTATION

CAP_ADVANCED_FORMS

public static final AgentCapabilityKey CAP_ADVANCED_FORMS

CAP_TABLES

public static final AgentCapabilityKey CAP_TABLES

CAP_FRAMES

public static final AgentCapabilityKey CAP_FRAMES

CAP_TARGET

public static final AgentCapabilityKey CAP_TARGET

CAP_IFRAMES

public static final AgentCapabilityKey CAP_IFRAMES

CAP_INTRINSIC_EVENTS

public static final AgentCapabilityKey CAP_INTRINSIC_EVENTS

CAP_STYLE_ATTRIBUTES

public static final AgentCapabilityKey CAP_STYLE_ATTRIBUTES

CAP_NAME_IDENTIFICATION

public static final AgentCapabilityKey CAP_NAME_IDENTIFICATION

CAP_VALIGN

public static final AgentCapabilityKey CAP_VALIGN

true if supports vertical alignment

CAP_ALT_RENDERS_TOOLTIP_ON_IMAGE

public static final AgentCapabilityKey CAP_ALT_RENDERS_TOOLTIP_ON_IMAGE

true if the alt key renders a tooltip for an image

CAP_SCRIPTING_SPEED

public static final AgentCapabilityKey CAP_SCRIPTING_SPEED

CAP_NEEDS_CELL_PLACEHOLDERS

public static final AgentCapabilityKey CAP_NEEDS_CELL_PLACEHOLDERS

True if the agent needs a placeholder to render an empty cell

CAP_MULTIPLE_WINDOWS

public static final AgentCapabilityKey CAP_MULTIPLE_WINDOWS

true if multiple windows can be opened

CAP_IMAGE_ENCODINGS

public static final AgentCapabilityKey CAP_IMAGE_ENCODINGS

Agent capability which identifies the set of image encodings supported by this Agent. The value is an Integer bit mask of the IMAGE_ENCODINGS_CAP_* constants.

CAP_NAVIGATION

public static final AgentCapabilityKey CAP_NAVIGATION

CAP_EDITING

public static final AgentCapabilityKey CAP_EDITING

DOM_CAP_NONE

public static final java.lang.Object DOM_CAP_NONE

DOM_CAP_FORM

public static final java.lang.Object DOM_CAP_FORM

DOM_CAP_LEVEL_1

public static final java.lang.Object DOM_CAP_LEVEL_1

DOM_CAP_LEVEL_2

public static final java.lang.Object DOM_CAP_LEVEL_2

SCRIPTING_SPEED_CAP_NONE

public static final java.lang.Object SCRIPTING_SPEED_CAP_NONE

SCRIPTING_SPEED_CAP_SLOW

public static final java.lang.Object SCRIPTING_SPEED_CAP_SLOW

SCRIPTING_SPEED_CAP_FAST

public static final java.lang.Object SCRIPTING_SPEED_CAP_FAST

TABLES_CAP_BASIC

public static final java.lang.Object TABLES_CAP_BASIC

TABLES_CAP_ADVANCED_ATTRS

public static final java.lang.Object TABLES_CAP_ADVANCED_ATTRS

TABLES_CAP_ADVANCED

public static final java.lang.Object TABLES_CAP_ADVANCED

STYLES_NONE

public static final java.lang.Object STYLES_NONE

STYLES_INTERNAL

public static final java.lang.Object STYLES_INTERNAL

STYLES_EXTERNAL

public static final java.lang.Object STYLES_EXTERNAL

IMAGE_ENCODINGS_CAP_PNG

public static final int IMAGE_ENCODINGS_CAP_PNG

IMAGE_ENCODINGS_CAP_TRANSPARENT_PNG

public static final int IMAGE_ENCODINGS_CAP_TRANSPARENT_PNG

IMAGE_ENCODINGS_CAP_GIF

public static final int IMAGE_ENCODINGS_CAP_GIF

IMAGE_ENCODINGS_CAP_JPEG

public static final int IMAGE_ENCODINGS_CAP_JPEG

IMAGE_ENCODINGS_CAP_BMP

public static final int IMAGE_ENCODINGS_CAP_BMP

TYPE_BROWSER

public static final int TYPE_BROWSER

Deprecated. Do not use this attribute

TYPE_DESKTOP

public static final int TYPE_DESKTOP

Application constant for Desktop devices

TYPE_PHONE

public static final int TYPE_PHONE

Application constant for Phone-sized devices

TYPE_PDA

public static final int TYPE_PDA

Application constant for Palm-sized devices. Pocket-PC, Palm

TYPE_VOICE

public static final int TYPE_VOICE

Application constant for voice

APPLICATION_UNKNOWN

public static final int APPLICATION_UNKNOWN

Application constant for an entirely unknown application.

APPLICATION_NETSCAPE

public static final int APPLICATION_NETSCAPE

Application constant for the Netscape Navigator browser. Note that Netscape 6 is considered as Mozilla, since its rendering engine is that of the Mozilla project.

APPLICATION_IEXPLORER

public static final int APPLICATION_IEXPLORER

Application constant for the Microsoft Internet Explorer browser.

APPLICATION_MOZILLA

public static final int APPLICATION_MOZILLA

Application constant for the Mozilla browser, or browsers based on it (like Netscape 6).

APPLICATION_WEB_CLIPPING

public static final int APPLICATION_WEB_CLIPPING

Application constant for Palm Web Clippings

APPLICATION_ICE

public static final int APPLICATION_ICE

Application constant for the ICE Browser

APPLICATION_PIXO

public static final int APPLICATION_PIXO

Application constant for the Pixo Microbrowser

APPLICATION_WML

public static final int APPLICATION_WML

Application constant for a WML Microbrowser

APPLICATION_SIMPLE_RESULT

public static final int APPLICATION_SIMPLE_RESULT

Application constant for SimpleResult intermediate Form

APPLICATION_PTG

public static final int APPLICATION_PTG

Application constant for iAS wireless (PTG) client

OS_UNKNOWN

public static final int OS_UNKNOWN

OS constant for an unknown operating system.

OS_WINDOWS

public static final int OS_WINDOWS

OS constant for any Microsoft Windows version.

OS_MACOS

public static final int OS_MACOS

OS constant for Apple MacOS.

OS_LINUX

public static final int OS_LINUX

OS constant for any Linux version.

OS_SOLARIS

public static final int OS_SOLARIS

OS constant for any Solaris version.

OS_PALM

public static final int OS_PALM

OS constant for any Palm version.

Method Detail

getAgentType

public int getAgentType()

Returns the type of agent to which we're rendering. Currently, only web browsers are understood.

getAgentApplication

public int getAgentApplication()

Returns the specific application to which we're rendering. Returns APPLICATION_UNKNOWN is the application couldn't be identified.

getAgentMajorVersion

public int getAgentMajorVersion()

Returns the major version number of the application, or 0 if a version number couldn't be identified.

getAgentVersion

public java.lang.String getAgentVersion()

Returns the full, unparsed version string. Returns null if no version string could be identified.

getAgentOS

public int getAgentOS()

Returns the client operating system. Returns OS_UNKNOWN if the operating system can't be identified.

getCapability

public java.lang.Object getCapability(AgentCapabilityKey key)

Returns a capability of an Agent

exportAgent

public java.lang.String exportAgent()

Serializes the Agent into a String for later deserialization. This is different than calling Agent.toString.