oracle.adf.share.config

Class ADFAuthoringSettings

java.lang.Object

oracle.adf.share.config.ADFAuthoringSettings

All Implemented Interfaces:

java.io.Serializable

public abstract class ADFAuthoringSettings
extends java.lang.Object
implements java.io.Serializable

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ADFAuthoringSettings.AuthoringMode Enum representing authoring/ development mode.

Field Summary

Fields

Modifier and Type	Field and Description
protected static java.lang.String	COMMON_DECORATOR
protected static java.lang.String	PREFIX
protected static java.lang.String	SUFFIX

Constructor Summary

Constructors

Constructor and Description
ADFAuthoringSettings()

Method Summary

Modifier and Type	Method and Description
abstract ADFAuthoringSettings.AuthoringMode	getAuthoringMode()
java.lang.String	getDecoratedShortName()
protected static java.lang.String	getDecoratedShortName(java.lang.String strShortName)
abstract java.lang.String	getShortName()
boolean	startsWithDecoratedShortName(java.lang.String name) Returns true if the specified name starts with decorated short name (as returned by the getDecoratedShortName API).

Methods inherited from class java.lang.Object

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

Field Detail

COMMON_DECORATOR

protected static final java.lang.String COMMON_DECORATOR

See Also:

Constant Field Values

PREFIX

protected static final java.lang.String PREFIX

See Also:

Constant Field Values

SUFFIX

protected static final java.lang.String SUFFIX

See Also:

Constant Field Values

Constructor Detail

ADFAuthoringSettings

public ADFAuthoringSettings()

Method Detail

getShortName

public abstract java.lang.String getShortName()

Returns:

the extension short name. This name is without any prefix or suffix

getDecoratedShortName

protected static final java.lang.String getDecoratedShortName(java.lang.String strShortName)

Parameters:

strShortName - shortname to be decorated This name is constructed as concatenation PREFIX+strShortName+SUFFIX

Returns:

the decorated name constructed from supplied parameter

getDecoratedShortName

public final java.lang.String getDecoratedShortName()

Returns:

the extension name to be used as a prefix to avoid collisions. This is a convience method that returns a decorated name constructed from getShortName() i.e. getDecortatedShortName(getShortName())

getAuthoringMode

public abstract ADFAuthoringSettings.AuthoringMode getAuthoringMode()

Returns:

the AuthoringMode which is NONE, VERTICAL or HORIZONTAL

startsWithDecoratedShortName

public boolean startsWithDecoratedShortName(java.lang.String name)

Returns true if the specified name starts with decorated short name (as returned by the getDecoratedShortName API). returns true if the name starts with PREFIX "__", followed by 1-5 alphanumeric characters, followed by SUFFIX "__"

Parameters:

name - the string to check

Returns: