Oracle Fusion Middleware Java API Reference for Oracle Extension SDK Reference
11g Release 1 (11.1.1.4.0)

E13403-05

oracle.jdeveloper.uieditor
Class UIEditorOptions

java.lang.Object
  extended by oracle.javatools.data.HashStructureAdapter
      extended by oracle.ide.config.ChangeEventSource
          extended by oracle.jdeveloper.uieditor.UIEditorOptions
All Implemented Interfaces:
Copyable

public class UIEditorOptions
extends ChangeEventSource
implements Copyable

UIEditorOptions describes the customizations made available to the user. Specifically code generation options and options for visual cues. Prorgramatic generation of source should always consult the UIEditorOptions object before generating source statements. Likewise, any LayoutAssistant supporting grid like visual cues should also consult these options.


Field Summary
static int DEFAULT_GRID_SPACING
          Default grid spacing for those LayoutAssistants supporting a grid.
static java.lang.String KEY_SETTINGS
          Settings key used in conjunction with the IdeSettings object.
static int PACKAGE_SCOPE
          Declaration scope of Java default 'package private'.
static int PRIVATE_SCOPE
          Declration scope of private.
static int PROTECTED_SCOPE
          Declaration scope of protected.
static int PUBLIC_SCOPE
          Declaration scope of public.
static java.lang.String[] TAGS
          Declaration tags.
 
Fields inherited from class oracle.javatools.data.HashStructureAdapter
_hash
 
Constructor Summary
UIEditorOptions()
          Constructor.
 
Method Summary
 java.lang.Object copyTo(java.lang.Object target)
          Copy all settings to the given target.
protected  void copyToImpl(UIEditorOptions copy)
          Copy settings from this instance into the given instance.
 int getDefaultMemberScope()
          Get the default member scope to use during source generation.
 int getGridSpacing()
          Get the grid spacing to be used for those LayoutAssistants that support grid behavior.
 boolean isGridVisible()
          Determine whether or not to display grid effects when working with LayoutAssistants that support a grid.
 boolean isMatchExistingCode()
          Determine whether or not to match existing inner class declarations during source generation.
 boolean isSnapToGrid()
          Determine whether or not to round coordinates and dimensions to the nearest factor of grid spacing when working with LayoutAssistants that support grid spacing.
 boolean isUseAnonymousInnerClass()
          Determine whether or not to use anonymous inner classes during source generation.
 boolean isUseBeansInstantiate()
          Determine whether or not to use Beans.instantiate during source generation of JavaBean variables.
 void setDefaultMemberScope(int defaultMemberScope)
          Set the default member scope to be used during source generation.
 void setGridSpacing(int gridSpacing)
          Set the grid spacing to be used by those LayoutAssistants that support grid behavior.
 void setGridVisible(boolean gridVisible)
          Set whether or not to display grid effects when working with LayoutAssistants that support a grid.
 void setMatchExistingCode(boolean matchExistingCode)
          Set whether or not to match existing style of inner classes during source generation.
 void setSnapToGrid(boolean snapToGrid)
          Set whether or not to round coordinates and dimensions to the nearest factor of grid spacing when working with LayoutAssistants that support grid spacing.
 void setUseAnonymousInnerClass(boolean useAnonymousInnerClass)
          Set whether or not anonymous inner classes are to be used during source generation.
 void setUseBeansInstantiate(boolean useBeansInstantiate)
          Set whether or not to use Beans.instantiate during source generation of JavaBean variables.
 
Methods inherited from class oracle.ide.config.ChangeEventSource
addChangeListener, fireChangeEvent, fireChangeEvent, removeChangeListener, setUseObjectEquals
 
Methods inherited from class oracle.javatools.data.HashStructureAdapter
addStructureChangeListener, containsKey, copyToImpl, equals, equalsImpl, findOrCreate, forcedCopyTo, getHashStructure, removeStructureChangeListener, useObjectEquals
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

KEY_SETTINGS

public static final java.lang.String KEY_SETTINGS
Settings key used in conjunction with the IdeSettings object.

See Also:
Constant Field Values

DEFAULT_GRID_SPACING

public static final int DEFAULT_GRID_SPACING
Default grid spacing for those LayoutAssistants supporting a grid.

See Also:
Constant Field Values

PUBLIC_SCOPE

public static final int PUBLIC_SCOPE
Declaration scope of public.

See Also:
Constant Field Values

PROTECTED_SCOPE

public static final int PROTECTED_SCOPE
Declaration scope of protected.

See Also:
Constant Field Values

PACKAGE_SCOPE

public static final int PACKAGE_SCOPE
Declaration scope of Java default 'package private'.

See Also:
Constant Field Values

PRIVATE_SCOPE

public static final int PRIVATE_SCOPE
Declration scope of private.

See Also:
Constant Field Values

TAGS

public static final java.lang.String[] TAGS
Declaration tags.

Constructor Detail

UIEditorOptions

public UIEditorOptions()
Constructor.

Method Detail

isUseAnonymousInnerClass

public boolean isUseAnonymousInnerClass()
Determine whether or not to use anonymous inner classes during source generation.

Returns:
true if anonymous inner classes are to be used
See Also:
setUseAnonymousInnerClass(boolean)

setUseAnonymousInnerClass

public void setUseAnonymousInnerClass(boolean useAnonymousInnerClass)
Set whether or not anonymous inner classes are to be used during source generation.

Parameters:
useAnonymousInnerClass - whether or not to use anonymouse inner classes.
See Also:
#isAnonymousInnerClass

isMatchExistingCode

public boolean isMatchExistingCode()
Determine whether or not to match existing inner class declarations during source generation.

Returns:
true if inner classes style is to be matched
See Also:
setMatchExistingCode(boolean)

setMatchExistingCode

public void setMatchExistingCode(boolean matchExistingCode)
Set whether or not to match existing style of inner classes during source generation.

Parameters:
matchExistingCode - whether or not to use match existing code
See Also:
isMatchExistingCode()

getDefaultMemberScope

public int getDefaultMemberScope()
Get the default member scope to use during source generation.

Returns:
one of PUBLIC, PROTECTED, PACKAGE, PRIVATE
See Also:
setDefaultMemberScope(int), #PUBLIC, #PROTECTED, #PACKAGE, #PRIVATE

setDefaultMemberScope

public void setDefaultMemberScope(int defaultMemberScope)
Set the default member scope to be used during source generation.

Parameters:
defaultMemberScope - one of PUBLIC, PROTECTED, PACKAGE, PRIVATE
See Also:
getDefaultMemberScope(), #PUBLIC, #PROTECTED, #PACKAGE, #PRIVATE

getGridSpacing

public int getGridSpacing()
Get the grid spacing to be used for those LayoutAssistants that support grid behavior.

Returns:
the grid spacing in pixels to be used
See Also:
setGridSpacing(int)

setGridSpacing

public void setGridSpacing(int gridSpacing)
Set the grid spacing to be used by those LayoutAssistants that support grid behavior.

Parameters:
gridSpacing - the grid spacing in pixels to use
See Also:
getGridSpacing()

isSnapToGrid

public boolean isSnapToGrid()
Determine whether or not to round coordinates and dimensions to the nearest factor of grid spacing when working with LayoutAssistants that support grid spacing.

Returns:
true if coordinates and dimensions should be rounded.
See Also:
setSnapToGrid(boolean), getGridSpacing(), setGridSpacing(int)

setSnapToGrid

public void setSnapToGrid(boolean snapToGrid)
Set whether or not to round coordinates and dimensions to the nearest factor of grid spacing when working with LayoutAssistants that support grid spacing.

Parameters:
snapToGrid - whether or not to round coordinates and dimensions
See Also:
isSnapToGrid(), getGridSpacing(), setGridSpacing(int)

isGridVisible

public boolean isGridVisible()
Determine whether or not to display grid effects when working with LayoutAssistants that support a grid.

Returns:
true if grid effects should be displayed
See Also:
setGridVisible(boolean)

setGridVisible

public void setGridVisible(boolean gridVisible)
Set whether or not to display grid effects when working with LayoutAssistants that support a grid.

Parameters:
gridVisible - whether or not to display grid effects
See Also:
isGridVisible()

isUseBeansInstantiate

public boolean isUseBeansInstantiate()
Determine whether or not to use Beans.instantiate during source generation of JavaBean variables.

Returns:
true if Beans.instantiate should be generated
See Also:
setUseBeansInstantiate(boolean), java.beans.Beans.instantiate

setUseBeansInstantiate

public void setUseBeansInstantiate(boolean useBeansInstantiate)
Set whether or not to use Beans.instantiate during source generation of JavaBean variables.

Parameters:
useBeansInstantiate - whether or not to use Beans.instantiate
See Also:
isUseBeansInstantiate(), java.beans.Beans.instantiate

copyTo

public java.lang.Object copyTo(java.lang.Object target)
Copy all settings to the given target.

Specified by:
copyTo in interface Copyable
Overrides:
copyTo in class ChangeEventSource
Parameters:
target - a UIEditorOptions into which to copy all settings
Returns:
Object an identical UIEditorOptions object

copyToImpl

protected final void copyToImpl(UIEditorOptions copy)
Copy settings from this instance into the given instance.

Parameters:
copy - the UIEditorOptions in which to copy our values.

Oracle Fusion Middleware Java API Reference for Oracle Extension SDK Reference
11g Release 1 (11.1.1.4.0)

E13403-05

Copyright © 1997, 2011, Oracle. All rights reserved.