|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object com.atlassian.gadgets.view.ViewType
public final class ViewType
Represents a context under which a gadget will be viewed. ViewType
s can be registered via
createViewType
and unregistered via removeViewType
.
Field Summary | |
---|---|
static ViewType |
CANVAS
|
static ViewType |
DEFAULT
|
Method Summary | |
---|---|
static ViewType |
createViewType(String name,
String... aliases)
Creates a ViewType with the given canonical name and optional aliases. |
Collection<String> |
getAliases()
Gets the aliases for this ViewType |
String |
getCanonicalName()
Gets the canonical name of this ViewType |
static boolean |
removeViewType(ViewType viewType)
Removes a ViewType . |
String |
toString()
|
static ViewType |
valueOf(String value)
Returns the ViewType associated with the value . |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Field Detail |
---|
public static final ViewType DEFAULT
public static final ViewType CANVAS
Method Detail |
---|
public static ViewType createViewType(String name, String... aliases)
ViewType
with the given canonical name and optional aliases. The name
and
aliases
must be unique : no two ViewTypes
can share names or aliases. If any of the name
or aliases
is associated with another ViewType
, an IllegalArgumentException
will be thrown
name
- the unique canonical name for the ViewType
aliases
- optional aliases for this ViewType
ViewType
public static boolean removeViewType(ViewType viewType)
ViewType
. Its name and all its aliases are free to be used in new ViewTypes
viewType
-
public String getCanonicalName()
ViewType
public Collection<String> getAliases()
ViewType
ViewType
's aliasespublic static ViewType valueOf(String value)
ViewType
associated with the value
. Previously, a ViewType
must
have been created (and not subsequently deleted) with the name value
or with an alias value
.
If no such ViewType
exists, an IllegalArgumentException
will be thrown.
value
-
public String toString()
toString
in class Object
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |