com.atlassian.gadgets.view
Class View

java.lang.Object
  com.atlassian.gadgets.view.View

@Immutable
public final class View
extends Object

Models information the renderer needs to know about a gadget to render it properly.

Nested Class Summary

static class

View.Builder Builder for View.

Field Summary

static View

DEFAULT Default View, which uses the default ViewType and is writable.

Method Summary

ViewType	getViewType() Returns the ViewType of this gadget which will be rendered.
boolean	isWritable() Returns true if the viewer is allowed to make changes to the gadget state.
Map<String,String>	paramsAsMap() Returns an unmodifiable Map of all view parameters.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

DEFAULT

public static final View DEFAULT

Default View, which uses the default ViewType and is writable.

Method Detail

getViewType

public ViewType getViewType()

Returns the ViewType of this gadget which will be rendered.

Returns:

the ViewType to render

isWritable

public boolean isWritable()

Returns true if the viewer is allowed to make changes to the gadget state.

Returns:

true if the viewer is allowed to make changes

paramsAsMap

public Map<String,String> paramsAsMap()

Returns an unmodifiable Map of all view parameters.

Returns:

an unmodifiable Map of all view parameters