Overview | Package | Class | Use | Tree | Deprecated | Index | Help
| fop 1.0
PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD

## org.apache.fop.render
Interface RenderingContext

All Known Implementing Classes:
  AbstractRenderingContext

public interface RenderingContext

Implementations of this interface provide context information needed by supporting classes during specific tasks (like image rendering).

Method Summary
`java.lang.Object` | `getHint(java.lang.Object key)` Returns a hint identified by a key.
`java.util.Map` | `getHints()` Returns an unmodifiable representation of all hints.
`java.lang.String` | `getMimeType()` Returns the MIME type associated with the current output format.
`FOUserAgent` | `getUserAgent()` Returns the user agent.
`void` | `putHint(java.lang.Object key, java.lang.Object value)` Sets an additional hint, overriding an existing hint.
`void` | `putHints(java.util.Map additionalHints)` Adds additional hints to the existing hints, overriding existing hints.

Method Detail

### getMimeType

    public java.lang.String getMimeType()

  Returns the MIME type associated with the current output format.

  Returns:
    the MIME type (ex. application/pdf)

### getUserAgent

    public FOUserAgent getUserAgent()

  Returns the user agent. The user agent is used to access configuration and other information for the rendering process.

  Returns:
    the user agent

### putHints

    public void putHints(java.util.Map additionalHints)

  Adds additional hints to the existing hints, overriding existing hints.

  Parameters:
    `additionalHints` - a map of additional hints

### putHint

    public void putHint(java.lang.Object key,
                        java.lang.Object value)

  Sets an additional hint, overriding an existing hint.

  Parameters:
    `key` - the key
    `value` - the value

### getHints

    public java.util.Map getHints()

  Returns an unmodifiable representation of all hints.

  Returns:
    the hints

### getHint

    public java.lang.Object getHint(java.lang.Object key)

  Returns a hint identified by a key.

  Parameters:
    `key` - the key
  Returns:
    the hint or null if no hint with the given key could be found

Overview | Package | Class | Use | Tree | Deprecated | Index | Help
| fop 1.0
PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD

Copyright 1999-2010 The Apache Software Foundation. All Rights Reserved.