public class handle extends BaseDataType
WrappedResource
. Such
objects can be passed around as a regular BaseDataType
wrapper
but the backing object can be indirectly accessed via the get()
method.
The following is the mapping of Progress language features to the corresponding feature in this class:
string function (default format)toString()
(user-defined format)toString(String)
(export format)toStringExport()
valid-handle functionisValid()
widget-handle functionfromString(com.goldencode.p2j.util.character)
There are 2 deviations between this class and its behavior in the Progress 4GL:
fromString(com.goldencode.p2j.util.character)
which
depends upon a map maintained during toString()
. The
solution is the same as for the oversized text representation
problem above (a registry created at construction of every
handle).
Modifier and Type | Class and Description |
---|---|
private static class |
handle.InvalidAttributeAccess
Handler for the
invalidAttrAccessProxy proxy. |
private static class |
handle.WorkArea
Stores global data relating to the state of the current context.
|
Modifier and Type | Field and Description |
---|---|
private static HandleCommon |
invalidAttrAccessProxy
Dynamic proxy returned by unwrap APIs when the handle is invalid or not
of the expected type.
|
private static java.util.logging.Logger |
LOG
Logger
|
private WrappedResource |
value
Stores the referenced data of this handle.
|
private static ContextLocal<handle.WorkArea> |
work
Stores context-local state variables.
|
private static WrappedResource |
ZERO_RESOURCE
A "zero" pseudo-resource.
|
Constructor and Description |
---|
handle()
Default constructor, creates an instance that represents the unknown
value.
|
handle(BaseDataType value)
This is a special c'tor which should be used only when converting the
value returned by a function or method with polymorphic return type into the
expected type (i.e.
|
handle(CommonFrame value)
Constructs an instance that has the contained object reference.
|
handle(handle value)
Constructs an instance that has the contained object reference and
unknown value that exactly matches that of the passed-in
instance. |
handle(WrappedResource value)
Constructs an instance that has the contained object reference.
|
Modifier and Type | Method and Description |
---|---|
boolean |
_isValid()
Determines if this instance is valid (to be used).
|
boolean |
_isValidEvent(character event)
Verifies whether the specified event is valid for the widget referenced by this handle.
|
boolean |
_isValidEvent(java.lang.String event)
Verifies whether the specified event is valid for the widget referenced by this handle.
|
void |
assign(BaseDataType value,
boolean force)
Sets the state (data and unknown value) of this instance based on the state of the passed
instance.
|
void |
assign(handle value)
Sets the state (data and unknown value) of this instance based on the
state of the passed instance.
|
void |
assign(handle value,
boolean force)
Sets the state (data and unknown value) of this instance based on the
state of the passed instance.
|
void |
assign(java.lang.Object value)
Sets the state (data and unknown value) of this instance based on the
state of the passed instance.
|
void |
assign(Undoable value)
Sets the state (data and unknown value) of this instance based on the
state of the passed instance.
|
void |
assign(WrappedResource value)
Sets the state (data and unknown value) of this instance based on the
given value.
|
void |
assign(WrappedResource value,
boolean force)
Sets the state (data and unknown value) of this instance based on the
state of the passed instance.
|
static handle |
buildExternalResource()
Build an
ExternalResource instance and associated an ID to it. |
int |
compareTo(java.lang.Object obj)
Compares this instance with the specified instance and returns a -1
if this instance is less than the specified, 0 if the two instances
are equal and 1 if this instance is greater than the specified
instance.
|
java.lang.String |
defaultFormatString()
Return the default display format string for this type.
|
BaseDataType |
duplicate()
Does the same as standard
clone() method but returns an
instance of BaseDataType and doesn't throw the
CloneNotSupportedException . |
static handle |
fromResourceId(java.lang.Long resourceId)
Converts the number representation of a handle into the original handle instance.
|
static handle |
fromString(character txt)
Convert the string representation of a handle into the original handle
instance.
|
static handle |
fromString(java.lang.String txt)
Convert the string representation of a handle into the original handle
instance.
|
java.lang.Object |
get()
Returns the value of this instance as an
Object . |
private static java.lang.String |
getAttrOrMethodName(java.lang.reflect.Method method,
java.lang.Object[] args)
Get the legacy attribute or method name mapped by this method.
|
WrappedResource |
getResource()
Getter for the wrapped resource.
|
java.lang.Long |
getResourceId()
Get resource ID as a long value.
|
int |
hashCode()
Hash code implementation which is consistent with
BaseDataType.equals(java.lang.Object) . |
BaseDataType |
instantiateUnknown()
Creates a new instance of the same type that represents the
unknown value . |
static void |
invalidAttribute(java.lang.String attr,
handle h)
This API should be called only in case of a attribute/method access using a resource which
does not support it.
|
boolean |
isExternalResource()
Check if this resource is an
ExternalResource . |
static boolean |
isHandleTypeOf(handle handleToCheck,
java.lang.Class<?> clazz)
Check the type of resource in the handle.
|
boolean |
isUnknown()
Determines if this instance represents the
unknown value . |
logical |
isValid()
Determines if this instance is valid (to be used).
|
logical |
isValidEvent(character event)
Verifies whether the specified event is valid for the widget referenced by this handle.
|
logical |
isValidEvent(java.lang.String event)
Verifies whether the specified event is valid for the widget referenced by this handle.
|
(package private) static boolean |
knownResource(WrappedResource resource)
Check if the given resource is known (has an associated ID).
|
void |
readExternal(java.io.ObjectInput in)
Replacement for the default object reading method.
|
static void |
readOnlyError(handle h,
java.lang.String attribute)
Emitted and to be used only in cases the attribute is read-only.
|
static void |
removeResource(WrappedResource resource)
Remove the given resource from the context-local map of all resource.
|
static java.lang.Long |
resourceId(WrappedResource resource)
Get the ID of the given resource, as used by the
toString() and
fromString(com.goldencode.p2j.util.character) APIs. |
void |
set(WrappedResource value)
Set the value of this instance as a
WrappedResource . |
void |
setUnknown()
Sets the state of this instance's
unknown value flag to
true . |
java.lang.String |
toString()
Creates a string representation of the instance data using the format
ResourceIdHelper.DEFAULT_FORMAT . |
java.lang.String |
toString(java.lang.String fmt)
Creates a string representation of the instance data using the user
specified format string (Progress 4GL compatible) or if no such string
is provided, the default format of
ResourceIdHelper.DEFAULT_FORMAT . |
java.lang.String |
toStringExport()
Creates a string representation of the instance data using the 'export'
format.
|
java.lang.String |
toStringMessage()
Creates a string representation of the instance data in a form that is
compatible with the
MESSAGE language statement. |
CommonHandleChain |
unwrap()
Unwrap this handle to a
CommonHandleChain instance. |
ADMData |
unwrapADMData()
Unwrap this handle to a
ADMData instance. |
AsyncRequest |
unwrapAsync()
Unwrap this handle to a
AsyncRequest instance. |
AsyncRequestCountAttribute |
unwrapAsyncRequestCount()
Unwrap this handle to a
AsyncRequestCountAttribute instance. |
AutoZapElement |
unwrapAutoZapElement()
Unwrap this handle to a
AutoZapElement instance. |
BlankInterface |
unwrapBlank()
Unwrap this handle to a
BlankInterface instance. |
BoxInterface |
unwrapBox()
Unwrap this handle to a
BoxInterface instance. |
BrowseInterface |
unwrapBrowse()
Unwrap this handle to a
BrowseInterface instance. |
BrowseColumnInterface |
unwrapBrowseColumn()
Unwrap this handle to a
BrowseColumnInterface instance. |
BrowseElement |
unwrapBrowseElement()
Unwrap this handle to a
BrowseElement instance. |
Buffer |
unwrapBuffer()
Unwrap this handle to a
Buffer instance. |
BufferField |
unwrapBufferField()
Unwrap this handle to a
BufferField instance. |
ButtonInterface |
unwrapButton()
Unwrap this handle to a
ButtonInterface instance. |
Clipboard |
unwrapClipboard()
Unwrap this handle to a
Clipboard instance. |
ColorTableResource |
unwrapColorTable()
Unwrap this handle to a
ColorTableResource instance. |
CommonField |
unwrapCommonField()
Unwrap this handle to a
CommonField instance. |
CommonListWidget |
unwrapCommonListWidget()
Unwrap this handle to a
CommonWidget instance. |
CommonProcedure |
unwrapCommonProcedure()
Unwrap this handle to a
CommonProcedure instance. |
Connectable |
unwrapConnectable()
Unwrap this handle to a
Connectable instance. |
ConnectableServer |
unwrapConnectableServer()
Unwrap this handle to a
ConnectableServer instance. |
ControlFrame |
unwrapControlFrame()
Unwrap this handle to a
ControlFrame instance. |
DatabaseInfo |
unwrapDatabaseInfo()
Unwrap this handle to a
DatabaseInfo instance. |
DeblankInterface |
unwrapDeblank()
Unwrap this handle to a
DeblankInterface instance. |
Dereferenceable |
unwrapDereferenceable()
Unwrap this handle to a
Dereferenceable instance. |
DirectManipulation |
unwrapDirectManipulation()
Unwrap this handle to a
DirectManipulation instance. |
Down |
unwrapDown()
Unwrap this handle to a
Down instance. |
Droppable |
unwrapDroppable()
Unwrap this handle to a
Droppable instance. |
DynamicResource |
unwrapDynamicResource()
Unwrap this handle to a
DynamicResource instance. |
EditorInterface |
unwrapEditor()
Unwrap this handle to an
EditorInterface instance. |
Encoding |
unwrapEncoding()
Unwrap this handle to a
XmlSchema instance. |
Errorable |
unwrapError()
Unwrap this handle to a
Errorable instance. |
CommonErrorStatus |
unwrapErrorStatus()
Unwrap this handle to a
CommonErrorStatus instance. |
CommonFile |
unwrapFile()
Unwrap this handle to a
CommonFile instance. |
CommonFileInfo |
unwrapFileInfo()
Unwrap this handle to a
CommonFileInfo instance. |
FirstLastProcedureAttribute |
unwrapFirstLastProcedure()
Unwrap this handle to a
FirstLastProcedureAttribute instance. |
FontTableResource |
unwrapFontTable()
Unwrap this handle to a
FontTableResource instance. |
FrameInterface |
unwrapFrame()
Unwrap this handle to an
FrameInterface instance. |
FWDTimer |
unwrapFWDTimer()
Unwrap this handle to a
FWDTimer instance. |
ImageSupport |
unwrapImageSupport()
Unwrap this handle to a
ImageSupport instance. |
ImageWidgetSupport |
unwrapImageWidgetSupport()
Unwrap this handle to a
ImageWidgetSupport instance. |
private static <T> T |
unwrapImpl(handle h,
java.lang.Class<T> ifc)
Unwrap the given handle so that it returns an instance compatible with
the given interface,
ifc . |
IndexedInterface |
unwrapIndexed()
Unwrap this handle to a
IndexedInterface instance. |
IndexInformation |
unwrapIndexInformation()
Unwrap this handle to a
IndexInformation instance. |
InnerLines |
unwrapInnerLines()
Unwrap this handle to a
InnerLines instance. |
InstantiatingProcedure |
unwrapInstantiatingProcedure()
Unwrap this handle to a
InstantiatingProcedure instance. |
IterableResource |
unwrapIterableResource()
Unwrap this handle to a
IterableResource instance. |
Labels |
unwrapLabels()
Unwrap this handle to a
Labels instance. |
CommonLastEvent |
unwrapLastEvent()
Unwrap this handle to a
CommonLastEvent instance. |
LocalName |
unwrapLocalName()
Unwrap this handle to a
LocalName instance. |
LegacyLogManager |
unwrapLogManager()
Unwrap this handle to a
LegacyLogManager instance. |
MaxCharsElement |
unwrapMaxCharsElement()
Unwrap this handle to a
MaxCharsElement instance. |
MenuInterface |
unwrapMenu()
Unwrap this handle to an
MenuInterface instance. |
MenuItemInterface |
unwrapMenuItem()
Unwrap this handle to an
MenuItemInterface instance. |
Multiple |
unwrapMultiple()
Unwrap this handle to a
Multiple instance. |
NamespaceURI |
unwrapNamespaceURI()
Unwrap this handle to a
NamespaceURI instance. |
NumEntries |
unwrapNumEntries()
Unwrap this handle to a
NumEntries instance. |
NumItems |
unwrapNumItems()
Unwrap this handle to a
NumItems instance. |
OrientationInterface |
unwrapOrientation()
Unwrap this handle to a
OrientationInterface instance. |
PasswordFieldInterface |
unwrapPasswordField()
Unwrap this handle to a
PasswordFieldInterface instance. |
PersistentProcedure |
unwrapProcedure()
Unwrap this handle to a
PersistentProcedure instance. |
P2JQuery |
unwrapQuery()
Unwrap this handle to a
P2JQuery instance. |
QueryAssociable |
unwrapQueryAssociable()
Unwrap this handle to a
QueryAssociable instance. |
RadioSetInterface |
unwrapRadioSet()
Unwrap this handle to a
RadioSetInterface instance. |
RcodeInfo |
unwrapRcodeInfo()
Unwrap this handle to a
RcodeInfo instance. |
RectangleInterface |
unwrapRectangle()
Unwrap this handle to a
RectangleInterface instance. |
Remotable |
unwrapRemotable()
Unwrap this handle to a
Remotable instance. |
ReplaceInterface |
unwrapReplace()
Unwrap this handle to an
ReplaceInterface instance. |
ResultListHandler |
unwrapResultListHandler()
Unwrap this handle to a
ResultListHandler instance. |
SaxAttributes |
unwrapSaxAttributes()
Unwrap this handle to a
SaxAttributes instance. |
SaxEntity |
unwrapSaxEntity()
Unwrap this handle to a
SaxEntity instance. |
SaxReader |
unwrapSaxReader()
Unwrap this handle to a
SaxReader instance. |
SaxWriter |
unwrapSaxWriter()
Unwrap this handle to a
SaxWriter instance. |
ScrollbarHorizontalElement |
unwrapScrollbarHorizontalElement()
Unwrap this handle to a
ScrollbarHorizontalElement instance. |
ScrollbarVerticalElement |
unwrapScrollbarVerticalElement()
Unwrap this handle to a
ScrollbarVerticalElement instance. |
SelectableText |
unwrapSelectableText()
Unwrap this handle to a
SelectableText instance. |
SelectionListInterface |
unwrapSelectionList()
Unwrap this handle to a
SelectionListInterface instance. |
Sensitive |
unwrapSensitive()
Unwrap this handle to a
Sensitive instance. |
Server |
unwrapServer()
Unwrap this handle to a
Server instance. |
CommonSession |
unwrapSession()
Unwrap this handle to a
CommonProcedure instance. |
Sizeable |
unwrapSizeable()
Unwrap this handle to a
Sizeable instance. |
SliderInterface |
unwrapSlider()
Unwrap this handle to a
SliderInterface instance. |
SOAPEntity |
unwrapSOAPEntity()
Unwrap this handle to a
SOAPEntity instance. |
SOAPFault |
unwrapSOAPFault()
Unwrap this handle to a
SOAPFault instance. |
SOAPHeader |
unwrapSOAPHeader()
Unwrap this handle to a
SOAPHeader instance. |
SOAPHeaderEntry |
unwrapSOAPHeaderEntry()
Unwrap this handle to a
SOAPHeaderEntry instance. |
Socket |
unwrapSocket()
Unwrap this handle to a
Socket instance. |
SocketListener |
unwrapSocketListener()
Unwrap this handle to a
SocketListener instance. |
SortedElement |
unwrapSortedElement()
Unwrap this handle to a
SortedElement instance. |
SslServerAttribute |
unwrapSslServerAttribute()
Unwrap this handle to a
SslServerAttribute instance. |
SubTypeAttribute |
unwrapSubType()
Unwrap this handle to a
SubTypeAttribute instance. |
TempTable |
unwrapTempTable()
Unwrap this handle to a
TempTable instance. |
TopOnlyInterface |
unwrapTopOnly()
Unwrap this handle to an
TopOnlyInterface instance. |
CommonHandleTree |
unwrapTree()
Unwrap this handle to a
CommonHandleTree instance. |
CommonHandle |
unwrapType()
Unwrap this handle to a
CommonHandle instance. |
UniqueID |
unwrapUniqueID()
Unwrap this handle to a
UniqueID instance. |
CommonWidget |
unwrapWidget()
Unwrap this handle to a
CommonWidget instance. |
CommonWindow |
unwrapWindow()
Unwrap this handle to a
CommonWindow instance. |
XCommon |
unwrapXCommon()
Unwrap this handle to a
XCommon instance. |
XDocument |
unwrapXDocument()
Unwrap this handle to a
XDocument instance. |
XEntity |
unwrapXEntity()
Unwrap this handle to a
XEntity instance. |
XmlData |
unwrapXmlData()
Unwrap this handle to a
XmlData instance. |
XmlSchema |
unwrapXmlSchema()
Unwrap this handle to a
XmlSchema instance. |
XNodeRef |
unwrapXNodeRef()
Unwrap this handle to a
XNodeRef instance. |
XYCoordinates |
unwrapXY()
Unwrap this handle to a
XYCoordinates instance. |
void |
writeExternal(java.io.ObjectOutput out)
Replacement for the default object writing method.
|
assign, calcFormatLength, deepCopy, elementsOfType, equals, formatLength, generateDefault, generateUnknown, getTypeName, incompatibleTypesOnConversion, initializeDefaultExtent, instantiateDefault, instantiateDefaultExtent, isUnknownValue, maximum, minimum, notUnknownValue, sameType
changed, checkUndoable, checkUndoable, checkUndoable, getTransLevel, isGlobal, isUndoable, markUndoable, popBlock, rollback, setGlobal
private static final java.util.logging.Logger LOG
private static final ContextLocal<handle.WorkArea> work
private static HandleCommon invalidAttrAccessProxy
private WrappedResource value
private static final WrappedResource ZERO_RESOURCE
fromString(String)
method when a formally valid ID is
provided, but the ID doesn't denote a valid resource.
A zero resource is not valid but is not unknown.
public handle()
public handle(BaseDataType value)
assign(BaseDataType,boolean)
).value
- The value to be used for this instance.public handle(handle value)
unknown value
that exactly matches that of the passed-in
instance.value
- The instance to pattern from.public handle(WrappedResource value)
value
- The instance to pattern from.public handle(CommonFrame value)
value
- The frame instance.public static boolean isHandleTypeOf(handle handleToCheck, java.lang.Class<?> clazz)
true
if and only if handle
is valid and contains resource of specific type.handleToCheck
- The handle instance to check.clazz
- Specific class type which will be compare.true
if handleToCheck contains resource an instance of clazz,
false
otherwise.public static void readOnlyError(handle h, java.lang.String attribute)
h
- The handle used to access the attribute.attribute
- The read-only attribute.public static handle fromString(character txt)
toString()
. Such
handles are stored in a map for conversion purposes.txt
- A valid text representation of a handle.public static handle fromString(java.lang.String txt)
toString()
. Such
handles are stored in a map for conversion purposes.txt
- A valid text representation of a handle.public static handle fromResourceId(java.lang.Long resourceId)
For handles whose backing resources still exist and which have been cached by
their IDs via resourceId(WrappedResource)
(which is called at various points in
the handle's life cycle), the method returns a valid handle instance. For handles whose
backing resources no longer exist, or which have never had their backing resources cached,
the method returns a zero handle, i.e. handle with "0" string representation.
resourceId
- Resource identifier.public static void invalidAttribute(java.lang.String attr, handle h)
This must not be called in cases of a not-supported attribute invoked as a lvalue (i.e. a
setter for a not-supported attribute is invoked). In this case, call readOnlyError(com.goldencode.p2j.util.handle, java.lang.String)
.
attr
- The attribute/method name which is not supported by the handle.h
- The handle used to access the attribute/method.public static void removeResource(WrappedResource resource)
This method should be called by all wrapped resources when deleted,
that is all resources implementing WrappedResource
interface.
resource
- A resource instance to be removed.public static java.lang.Long resourceId(WrappedResource resource)
toString()
and
fromString(com.goldencode.p2j.util.character)
APIs.
The method allocates additional resources together with the provided wrapped resource,
thus it is necessary that removeResource(WrappedResource)
is called when
the returned resource id is not needed anymore (i.e. the related resource is deleted),
see removeResource(WrappedResource)
for more details.
resource
- A resource instance.static boolean knownResource(WrappedResource resource)
resource
- A resource, valid or not.true
if the resource has an associated ID.public static handle buildExternalResource()
ExternalResource
instance and associated an ID to it.ExternalResource
instance.private static <T> T unwrapImpl(handle h, java.lang.Class<T> ifc)
ifc
. If the handle is invalid or is
not compatible with the given interface, a dynamic proxy is returned
(see invalidAttrAccessProxy
.
Each unwrap call must be followed by an actual attribute/method invocation. This is needed because for invalid handles, a stack of handles is maintained, to know the state of the last used handle.
h
- The handle to be unwrapped.ifc
- The expected interface.private static java.lang.String getAttrOrMethodName(java.lang.reflect.Method method, java.lang.Object[] args)
method
- The method for which the legacy name is needed.args
- The method's arguments.public boolean isExternalResource()
ExternalResource
.true
if this is an ExternalResource
instance.public CommonHandleChain unwrap()
CommonHandleChain
instance. If the
handle is not a procedure, widget, window or frame handle or is invalid,
an dynamic proxy
is returned.
Each unwrap call must be followed by an actual attribute/method invocation. This is needed because for invalid handles, a stack of handles is maintained, to know the state of the last used handle.
public CommonHandleTree unwrapTree()
CommonHandleTree
instance. If the handle is
not a CommonHandleTree handle or is invalid, an
dynamic proxy
is returned.
Each unwrap call must be followed by an actual attribute/method invocation. This is needed because for invalid handles, a stack of handles is maintained, to know the state of the last used handle.
public ADMData unwrapADMData()
ADMData
instance. If the handle is
not a ADMData handle or is invalid, an
dynamic proxy
is returned.
Each unwrap call must be followed by an actual attribute/method invocation. This is needed because for invalid handles, a stack of handles is maintained, to know the state of the last used handle.
public AsyncRequest unwrapAsync()
AsyncRequest
instance. If the handle is
not a AsynchronousRequest
handle or is invalid, an
dynamic proxy
is returned.
Each unwrap call must be followed by an actual attribute/method invocation. This is needed because for invalid handles, a stack of handles is maintained, to know the state of the last used handle.
public AsyncRequestCountAttribute unwrapAsyncRequestCount()
AsyncRequestCountAttribute
instance. If the handle is
not a AsyncRequestCountAttribute handle or is invalid, an
dynamic proxy
is returned.
Each unwrap call must be followed by an actual attribute/method invocation. This is needed because for invalid handles, a stack of handles is maintained, to know the state of the last used handle.
public Buffer unwrapBuffer()
Buffer
instance. If the
handle is not the Buffer handle or is invalid, an
dynamic proxy
is returned.
Each unwrap call must be followed by an actual attribute/method invocation. This is needed because for invalid handles, a stack of handles is maintained, to know the state of the last used handle.
public BufferField unwrapBufferField()
BufferField
instance. If the
handle is not the BufferField handle or is invalid, an
dynamic proxy
is returned.
Each unwrap call must be followed by an actual attribute/method invocation. This is needed because for invalid handles, a stack of handles is maintained, to know the state of the last used handle.
public Clipboard unwrapClipboard()
Clipboard
instance. If the handle is not a Clipboard handle
or is invalid, an dynamic proxy
is returned.
Each unwrap call must be followed by an actual attribute/method invocation. This is needed because for invalid handles, a stack of handles is maintained, to know the state of the last used handle.
public ColorTableResource unwrapColorTable()
ColorTableResource
instance. If the handle is
not a ColorTableResource handle or is invalid, an
dynamic proxy
is returned.
Each unwrap call must be followed by an actual attribute/method invocation. This is needed because for invalid handles, a stack of handles is maintained, to know the state of the last used handle.
public ReplaceInterface unwrapReplace()
ReplaceInterface
instance. If the
handle is not an EditorInterface
handle or is invalid, an
dynamic proxy
is returned.
Each unwrap call must be followed by an actual attribute/method invocation. This is needed because for invalid handles, a stack of handles is maintained, to know the state of the last used handle.
public EditorInterface unwrapEditor()
EditorInterface
instance. If the
handle is not an EditorInterface
handle or is invalid, an
dynamic proxy
is returned.
Each unwrap call must be followed by an actual attribute/method invocation. This is needed because for invalid handles, a stack of handles is maintained, to know the state of the last used handle.
public BrowseInterface unwrapBrowse()
BrowseInterface
instance. If the
handle is not the BrowseInterface
handle or is invalid, an
dynamic proxy
is returned.
Each unwrap call must be followed by an actual attribute/method invocation. This is needed because for invalid handles, a stack of handles is maintained, to know the state of the last used handle.
public Labels unwrapLabels()
Labels
instance. If the
handle is not the Labels
handle or is invalid, an
dynamic proxy
is returned.
Each unwrap call must be followed by an actual attribute/method invocation. This is needed because for invalid handles, a stack of handles is maintained, to know the state of the last used handle.
public FrameInterface unwrapFrame()
FrameInterface
instance. If the
handle is not an FrameInterface
handle or is invalid, an
dynamic proxy
is returned.
Each unwrap call must be followed by an actual attribute/method invocation. This is needed because for invalid handles, a stack of handles is maintained, to know the state of the last used handle.
public TopOnlyInterface unwrapTopOnly()
TopOnlyInterface
instance. If the
handle is not an FrameInterface
handle or is invalid, an
dynamic proxy
is returned.
Each unwrap call must be followed by an actual attribute/method invocation. This is needed because for invalid handles, a stack of handles is maintained, to know the state of the last used handle.
public AutoZapElement unwrapAutoZapElement()
AutoZapElement
instance. If the
handle is not the AutoZapElement handle or is invalid, an
dynamic proxy
is returned.
Each unwrap call must be followed by an actual attribute/method invocation. This is needed because for invalid handles, a stack of handles is maintained, to know the state of the last used handle.
public ScrollbarHorizontalElement unwrapScrollbarHorizontalElement()
ScrollbarHorizontalElement
instance. If the
handle is not the ScrollbarHorizontalElement
handle or is invalid, an
dynamic proxy
is returned.
Each unwrap call must be followed by an actual attribute/method invocation. This is needed because for invalid handles, a stack of handles is maintained, to know the state of the last used handle.
public ScrollbarVerticalElement unwrapScrollbarVerticalElement()
ScrollbarVerticalElement
instance. If the
handle is not the ScrollbarVerticalElement handle or is invalid, an
dynamic proxy
is returned.
Each unwrap call must be followed by an actual attribute/method invocation. This is needed because for invalid handles, a stack of handles is maintained, to know the state of the last used handle.
public BrowseColumnInterface unwrapBrowseColumn()
BrowseColumnInterface
instance. If the
handle is not the BrowseColumnInterface handle or is invalid, an
dynamic proxy
is returned.
Each unwrap call must be followed by an actual attribute/method invocation. This is needed because for invalid handles, a stack of handles is maintained, to know the state of the last used handle.
public BrowseElement unwrapBrowseElement()
BrowseElement
instance. If the
handle is not the BrowseElement handle or is invalid, an
dynamic proxy
is returned.
Each unwrap call must be followed by an actual attribute/method invocation. This is needed because for invalid handles, a stack of handles is maintained, to know the state of the last used handle.
public InnerLines unwrapInnerLines()
InnerLines
instance. If the
handle is not the InnerLines
handle or is invalid, an
dynamic proxy
is returned.
Each unwrap call must be followed by an actual attribute/method invocation. This is needed because for invalid handles, a stack of handles is maintained, to know the state of the last used handle.
public MaxCharsElement unwrapMaxCharsElement()
MaxCharsElement
instance. If the
handle is not the MaxCharsElement handle or is invalid, an
dynamic proxy
is returned.
Each unwrap call must be followed by an actual attribute/method invocation. This is needed because for invalid handles, a stack of handles is maintained, to know the state of the last used handle.
public SortedElement unwrapSortedElement()
SortedElement
instance. If the
handle is not the SortedElement handle or is invalid, an
dynamic proxy
is returned.
Each unwrap call must be followed by an actual attribute/method invocation. This is needed because for invalid handles, a stack of handles is maintained, to know the state of the last used handle.
public CommonProcedure unwrapCommonProcedure()
CommonProcedure
instance. If the
handle is not a procedure or the SESSION system handle or is invalid,
an dynamic proxy
is returned.
Each unwrap call must be followed by an actual attribute/method invocation. This is needed because for invalid handles, a stack of handles is maintained, to know the state of the last used handle.
public CommonField unwrapCommonField()
CommonField
instance. If the
handle is not CommonField resource or is invalid,
an dynamic proxy
is returned.
Each unwrap call must be followed by an actual attribute/method invocation. This is needed because for invalid handles, a stack of handles is maintained, to know the state of the last used handle.
public Connectable unwrapConnectable()
Connectable
instance. If the
handle is not a Connectable handle or is invalid, an
dynamic proxy
is returned.
Each unwrap call must be followed by an actual attribute/method invocation. This is needed because for invalid handles, a stack of handles is maintained, to know the state of the last used handle.
public ConnectableServer unwrapConnectableServer()
ConnectableServer
instance. If the
handle is not a ConnectableServer handle or is invalid, an
dynamic proxy
is returned.
Each unwrap call must be followed by an actual attribute/method invocation. This is needed because for invalid handles, a stack of handles is maintained, to know the state of the last used handle.
public DatabaseInfo unwrapDatabaseInfo()
DatabaseInfo
instance. If the
handle is not a procedure, widget, window or frame handle or is invalid,
an dynamic proxy
is returned.
Each unwrap call must be followed by an actual attribute/method invocation. This is needed because for invalid handles, a stack of handles is maintained, to know the state of the last used handle.
public Dereferenceable unwrapDereferenceable()
Dereferenceable
instance. If the
handle is not the Dereferenceable handle or is invalid, an
dynamic proxy
is returned.
Each unwrap call must be followed by an actual attribute/method invocation to dereference(). This is needed because for invalid handles, a stack of handles is maintained, to know the state of the last used handle.
public DynamicResource unwrapDynamicResource()
DynamicResource
instance. If the
handle is not the DynamicResource handle or is invalid, an
dynamic proxy
is returned.
Each unwrap call must be followed by an actual attribute/method invocation to dereference(). This is needed because for invalid handles, a stack of handles is maintained, to know the state of the last used handle.
public Encoding unwrapEncoding()
XmlSchema
instance. If the
handle is invalid, an dynamic proxy
is returned.
Each unwrap call must be followed by an actual attribute/method invocation. This is needed because for invalid handles, a stack of handles is maintained, to know the state of the last used handle.
public Errorable unwrapError()
Errorable
instance. If the
handle is invalid, an
dynamic proxy
is returned.
Each unwrap call must be followed by an actual attribute/method invocation. This is needed because for invalid handles, a stack of handles is maintained, to know the state of the last used handle.
public CommonErrorStatus unwrapErrorStatus()
CommonErrorStatus
instance. If the
handle is not the ERROR-STATUS handle or is invalid, an
dynamic proxy
is returned.
Each unwrap call must be followed by an actual attribute/method invocation. This is needed because for invalid handles, a stack of handles is maintained, to know the state of the last used handle.
public CommonFile unwrapFile()
CommonFile
instance. If the
handle is not the FILE-INFO or a procedure handle or is invalid, an
dynamic proxy
is returned.
Each unwrap call must be followed by an actual attribute/method invocation. This is needed because for invalid handles, a stack of handles is maintained, to know the state of the last used handle.
public CommonFileInfo unwrapFileInfo()
CommonFileInfo
instance. If the
handle is not the FILE-INFO handle or is invalid, an
dynamic proxy
is returned.
Each unwrap call must be followed by an actual attribute/method invocation. This is needed because for invalid handles, a stack of handles is maintained, to know the state of the last used handle.
public FirstLastProcedureAttribute unwrapFirstLastProcedure()
FirstLastProcedureAttribute
instance. If the handle is
not a FirstLastProcedureAttribute handle or is invalid, an
dynamic proxy
is returned.
Each unwrap call must be followed by an actual attribute/method invocation. This is needed because for invalid handles, a stack of handles is maintained, to know the state of the last used handle.
public FontTableResource unwrapFontTable()
FontTableResource
instance. If the handle is
not a FontTableResource handle or is invalid, an
dynamic proxy
is returned.
Each unwrap call must be followed by an actual attribute/method invocation. This is needed because for invalid handles, a stack of handles is maintained, to know the state of the last used handle.
public InstantiatingProcedure unwrapInstantiatingProcedure()
InstantiatingProcedure
instance. If the handle is
not a FirstLastProcedureAttribute handle or is invalid, an
dynamic proxy
is returned.
Each unwrap call must be followed by an actual attribute/method invocation. This is needed because for invalid handles, a stack of handles is maintained, to know the state of the last used handle.
public MenuInterface unwrapMenu()
MenuInterface
instance. If the
handle is not an MenuInterface
handle or is invalid, an
dynamic proxy
is returned.
Each unwrap call must be followed by an actual attribute/method invocation. This is needed because for invalid handles, a stack of handles is maintained, to know the state of the last used handle.
public MenuItemInterface unwrapMenuItem()
MenuItemInterface
instance. If the
handle is not an MenuItemInterface
handle or is invalid, an
dynamic proxy
is returned.
Each unwrap call must be followed by an actual attribute/method invocation. This is needed because for invalid handles, a stack of handles is maintained, to know the state of the last used handle.
public NumEntries unwrapNumEntries()
NumEntries
instance. If the handle is
not a NumEntries handle or is invalid, an
dynamic proxy
is returned.
Each unwrap call must be followed by an actual attribute/method invocation. This is needed because for invalid handles, a stack of handles is maintained, to know the state of the last used handle.
public NumItems unwrapNumItems()
NumItems
instance. If the handle is not a NumItems handle
or is invalid, an dynamic proxy
is returned.
Each unwrap call must be followed by an actual attribute/method invocation. This is needed because for invalid handles, a stack of handles is maintained, to know the state of the last used handle.
public ButtonInterface unwrapButton()
ButtonInterface
instance. If the handle is not a
ButtonInterface handle or is invalid, an dynamic proxy
is
returned.
Each unwrap call must be followed by an actual attribute/method invocation. This is needed because for invalid handles, a stack of handles is maintained, to know the state of the last used handle.
public ImageSupport unwrapImageSupport()
ImageSupport
instance. If the handle is not an ImageSupport
handle or is invalid, an dynamic proxy
is returned.
Each unwrap call must be followed by an actual attribute/method invocation. This is needed because for invalid handles, a stack of handles is maintained, to know the state of the last used handle.
public ImageWidgetSupport unwrapImageWidgetSupport()
ImageWidgetSupport
instance. If the handle is not an
ImageWidgetSupport handle or is invalid, an dynamic proxy
is returned.
Each unwrap call must be followed by an actual attribute/method invocation. This is needed because for invalid handles, a stack of handles is maintained, to know the state of the last used handle.
public IterableResource unwrapIterableResource()
IterableResource
instance.
Each unwrap call must be followed by an actual attribute/method invocation. This is needed because for invalid handles, a stack of handles is maintained, to know the state of the last used handle.
public IndexedInterface unwrapIndexed()
IndexedInterface
instance.
Each unwrap call must be followed by an actual attribute/method invocation. This is needed because for invalid handles, a stack of handles is maintained, to know the state of the last used handle.
public SelectionListInterface unwrapSelectionList()
SelectionListInterface
instance. If the handle is not a
ButtonInterface handle or is invalid, an dynamic proxy
is
returned.
Each unwrap call must be followed by an actual attribute/method invocation. This is needed because for invalid handles, a stack of handles is maintained, to know the state of the last used handle.
public OrientationInterface unwrapOrientation()
OrientationInterface
instance. If the handle is not a
ButtonInterface handle or is invalid, an dynamic proxy
is
returned.
Each unwrap call must be followed by an actual attribute/method invocation. This is needed because for invalid handles, a stack of handles is maintained, to know the state of the last used handle.
public SliderInterface unwrapSlider()
SliderInterface
instance. If the handle is not a
ButtonInterface handle or is invalid, an dynamic proxy
is
returned.
Each unwrap call must be followed by an actual attribute/method invocation. This is needed because for invalid handles, a stack of handles is maintained, to know the state of the last used handle.
public CommonLastEvent unwrapLastEvent()
CommonLastEvent
instance. If the
handle is not the KEY-READER handle or is invalid, an
dynamic proxy
is returned.
Each unwrap call must be followed by an actual attribute/method invocation. This is needed because for invalid handles, a stack of handles is maintained, to know the state of the last used handle.
public LegacyLogManager unwrapLogManager()
LegacyLogManager
instance. If the
handle is not the LOG-MANAGER or DSLOG-MANAGER handle or is invalid, an
dynamic proxy
is returned.
Each unwrap call must be followed by an actual attribute/method invocation. This is needed because for invalid handles, a stack of handles is maintained, to know the state of the last used handle.
public LocalName unwrapLocalName()
LocalName
instance. If the handle is
not a LocalName handle or is invalid, an
dynamic proxy
is returned.
Each unwrap call must be followed by an actual attribute/method invocation. This is needed because for invalid handles, a stack of handles is maintained, to know the state of the last used handle.
public NamespaceURI unwrapNamespaceURI()
NamespaceURI
instance. If the handle is
not a NamespaceURI handle or is invalid, an
dynamic proxy
is returned.
Each unwrap call must be followed by an actual attribute/method invocation. This is needed because for invalid handles, a stack of handles is maintained, to know the state of the last used handle.
public PasswordFieldInterface unwrapPasswordField()
PasswordFieldInterface
instance. If
the handle is not a procedure handle or is invalid, an
dynamic proxy
is returned.
Each unwrap call must be followed by an actual attribute/method invocation. This is needed because for invalid handles, a stack of handles is maintained, to know the state of the last used handle.
public PersistentProcedure unwrapProcedure()
PersistentProcedure
instance. If
the handle is not a procedure handle or is invalid, an
dynamic proxy
is returned.
Each unwrap call must be followed by an actual attribute/method invocation. This is needed because for invalid handles, a stack of handles is maintained, to know the state of the last used handle.
public P2JQuery unwrapQuery()
P2JQuery
instance. If the
handle is not a query handle or is invalid, an
dynamic proxy
is returned.
Each unwrap call must be followed by an actual attribute/method invocation. This is needed because for invalid handles, a stack of handles is maintained, to know the state of the last used handle.
public QueryAssociable unwrapQueryAssociable()
QueryAssociable
instance. If the
handle is not a query handle or is invalid, an
dynamic proxy
is returned.
Each unwrap call must be followed by an actual attribute/method invocation. This is needed because for invalid handles, a stack of handles is maintained, to know the state of the last used handle.
public IndexInformation unwrapIndexInformation()
IndexInformation
instance. If the
handle is not a query handle or is invalid, an
dynamic proxy
is returned.
Each unwrap call must be followed by an actual attribute/method invocation. This is needed because for invalid handles, a stack of handles is maintained, to know the state of the last used handle.
public RcodeInfo unwrapRcodeInfo()
RcodeInfo
instance. If the
handle is not a RcodeInfo
handle or is invalid, an
dynamic proxy
is returned.
Each unwrap call must be followed by an actual attribute/method invocation. This is needed because for invalid handles, a stack of handles is maintained, to know the state of the last used handle.
public Remotable unwrapRemotable()
Remotable
instance. If the
handle is not a Remotable
handle or is invalid, an
dynamic proxy
is returned.
Each unwrap call must be followed by an actual attribute/method invocation. This is needed because for invalid handles, a stack of handles is maintained, to know the state of the last used handle.
public ResultListHandler unwrapResultListHandler()
ResultListHandler
instance. If the
handle is not a ResultListHandler
handle or is invalid, an
dynamic proxy
is returned.
Each unwrap call must be followed by an actual attribute/method invocation. This is needed because for invalid handles, a stack of handles is maintained, to know the state of the last used handle.
public SaxAttributes unwrapSaxAttributes()
SaxAttributes
instance. If the handle is invalid, an
dynamic proxy
is returned.
Each unwrap call must be followed by an actual attribute/method invocation. This is needed because for invalid handles, a stack of handles is maintained, to know the state of the last used handle.
public SaxEntity unwrapSaxEntity()
SaxEntity
instance. If the handle is invalid, an
dynamic proxy
is returned.
Each unwrap call must be followed by an actual attribute/method invocation. This is needed because for invalid handles, a stack of handles is maintained, to know the state of the last used handle.
public SaxReader unwrapSaxReader()
SaxReader
instance. If the handle is invalid, an
dynamic proxy
is returned.
Each unwrap call must be followed by an actual attribute/method invocation. This is needed because for invalid handles, a stack of handles is maintained, to know the state of the last used handle.
public SaxWriter unwrapSaxWriter()
SaxWriter
instance. If the handle is invalid, an
dynamic proxy
is returned.
Each unwrap call must be followed by an actual attribute/method invocation. This is needed because for invalid handles, a stack of handles is maintained, to know the state of the last used handle.
public Sensitive unwrapSensitive()
Sensitive
instance. If the
handle is not a Sensitive handle or is invalid, an
dynamic proxy
is returned.
Each unwrap call must be followed by an actual attribute/method invocation. This is needed because for invalid handles, a stack of handles is maintained, to know the state of the last used handle.
public ControlFrame unwrapControlFrame()
ControlFrame
instance. If the handle is not a ControlFrame
handle or is invalid, an dynamic proxy
is returned.
Each unwrap call must be followed by an actual attribute/method invocation. This is needed because for invalid handles, a stack of handles is maintained, to know the state of the last used handle.
public FWDTimer unwrapFWDTimer()
FWDTimer
instance. If the handle is not a FWDTimer
handle or is invalid, an dynamic proxy
is returned.
Each unwrap call must be followed by an actual attribute/method invocation. This is needed because for invalid handles, a stack of handles is maintained, to know the state of the last used handle.
public Down unwrapDown()
Down
instance. If the
handle is not a Down handle or is invalid, an
dynamic proxy
is returned.
Each unwrap call must be followed by an actual attribute/method invocation. This is needed because for invalid handles, a stack of handles is maintained, to know the state of the last used handle.
public Server unwrapServer()
Server
instance. If the handle is not a Server handle
or is invalid, an dynamic proxy
is returned.
Each unwrap call must be followed by an actual attribute/method invocation. This is needed because for invalid handles, a stack of handles is maintained, to know the state of the last used handle.
public CommonSession unwrapSession()
CommonProcedure
instance. If the
handle is not the SESSION system handle or is invalid,
an dynamic proxy
is returned.
Each unwrap call must be followed by an actual attribute/method invocation. This is needed because for invalid handles, a stack of handles is maintained, to know the state of the last used handle.
public Sizeable unwrapSizeable()
Sizeable
instance. If the
handle is not a procedure, widget, window or frame handle or is invalid,
an dynamic proxy
is returned.
Each unwrap call must be followed by an actual attribute/method invocation. This is needed because for invalid handles, a stack of handles is maintained, to know the state of the last used handle.
public Multiple unwrapMultiple()
Multiple
instance. If the
handle is not a procedure, widget, window or frame handle or is invalid,
an dynamic proxy
is returned.
Each unwrap call must be followed by an actual attribute/method invocation. This is needed because for invalid handles, a stack of handles is maintained, to know the state of the last used handle.
public SOAPEntity unwrapSOAPEntity()
SOAPEntity
instance. If the handle's resource is
not implementing the SOAPEntity
interface or is invalid, an
dynamic proxy
is returned.
Each unwrap call must be followed by an actual attribute/method invocation. This is needed because for invalid handles, a stack of handles is maintained, to know the state of the last used handle.
public SOAPFault unwrapSOAPFault()
SOAPFault
instance. If the handle's resource is
not implementing the SOAPFault
interface or is invalid, an
dynamic proxy
is returned.
Each unwrap call must be followed by an actual attribute/method invocation. This is needed because for invalid handles, a stack of handles is maintained, to know the state of the last used handle.
public SOAPHeader unwrapSOAPHeader()
SOAPHeader
instance. If the handle's resource is
not implementing the SOAPHeader
interface or is invalid, an
dynamic proxy
is returned.
Each unwrap call must be followed by an actual attribute/method invocation. This is needed because for invalid handles, a stack of handles is maintained, to know the state of the last used handle.
public SOAPHeaderEntry unwrapSOAPHeaderEntry()
SOAPHeaderEntry
instance. If the handle's resource is
not implementing the SOAPHeaderEntry
interface or is invalid, an
dynamic proxy
is returned.
Each unwrap call must be followed by an actual attribute/method invocation. This is needed because for invalid handles, a stack of handles is maintained, to know the state of the last used handle.
public Socket unwrapSocket()
Socket
instance. If the
handle is not the SOCKET handle or is invalid, an
dynamic proxy
is returned.
Each unwrap call must be followed by an actual attribute/method invocation. This is needed because for invalid handles, a stack of handles is maintained, to know the state of the last used handle.
public SocketListener unwrapSocketListener()
SocketListener
instance.
If the handle is not the SERVER-SOCKET handle or is invalid, an
dynamic proxy
is returned.
Each unwrap call must be followed by an actual attribute/method invocation. This is needed because for invalid handles, a stack of handles is maintained, to know the state of the last used handle.
public SslServerAttribute unwrapSslServerAttribute()
SslServerAttribute
instance. If the handle is not a
SslServerAttribute handle or is invalid, an dynamic proxy
is returned.
Each unwrap call must be followed by an actual attribute/method invocation. This is needed because for invalid handles, a stack of handles is maintained, to know the state of the last used handle.
public SubTypeAttribute unwrapSubType()
SubTypeAttribute
instance. If the handle is not a
SubTypeAttribute handle or is invalid, an dynamic proxy
is returned.
Each unwrap call must be followed by an actual attribute/method invocation. This is needed because for invalid handles, a stack of handles is maintained, to know the state of the last used handle.
public TempTable unwrapTempTable()
TempTable
instance. If the
handle is not a temporary handle or is invalid,
an dynamic proxy
is returned.
Each unwrap call must be followed by an actual attribute/method invocation. This is needed because for invalid handles, a stack of handles is maintained, to know the state of the last used handle.
public CommonHandle unwrapType()
CommonHandle
instance. If the
handle is invalid, an dynamic proxy
is returned.
Each unwrap call must be followed by an actual attribute/method invocation. This is needed because for invalid handles, a stack of handles is maintained, to know the state of the last used handle.
public UniqueID unwrapUniqueID()
UniqueID
instance. If the handle is
not a UniqueID handle or is invalid, an
dynamic proxy
is returned.
Each unwrap call must be followed by an actual attribute/method invocation. This is needed because for invalid handles, a stack of handles is maintained, to know the state of the last used handle.
public XCommon unwrapXCommon()
XCommon
instance. If the handle is invalid, an
dynamic proxy
is returned.
Each unwrap call must be followed by an actual attribute/method invocation. This is needed because for invalid handles, a stack of handles is maintained, to know the state of the last used handle.
public XEntity unwrapXEntity()
XEntity
instance. If the
handle is invalid, an dynamic proxy
is returned.
Each unwrap call must be followed by an actual attribute/method invocation. This is needed because for invalid handles, a stack of handles is maintained, to know the state of the last used handle.
public XDocument unwrapXDocument()
XDocument
instance. If the
handle is invalid, an dynamic proxy
is returned.
Each unwrap call must be followed by an actual attribute/method invocation. This is needed because for invalid handles, a stack of handles is maintained, to know the state of the last used handle.
public XmlSchema unwrapXmlSchema()
XmlSchema
instance. If the
handle is invalid, an dynamic proxy
is returned.
Each unwrap call must be followed by an actual attribute/method invocation. This is needed because for invalid handles, a stack of handles is maintained, to know the state of the last used handle.
public XNodeRef unwrapXNodeRef()
XNodeRef
instance. If the
handle is invalid, an dynamic proxy
is returned.
Each unwrap call must be followed by an actual attribute/method invocation. This is needed because for invalid handles, a stack of handles is maintained, to know the state of the last used handle.
public CommonWidget unwrapWidget()
CommonWidget
instance. If the
handle is not a widget handle or is invalid, an
dynamic proxy
is returned.
Each unwrap call must be followed by an actual attribute/method invocation. This is needed because for invalid handles, a stack of handles is maintained, to know the state of the last used handle.
public SelectableText unwrapSelectableText()
SelectableText
instance. If the
handle is not a widget handle or is invalid, an
dynamic proxy
is returned.
Each unwrap call must be followed by an actual attribute/method invocation. This is needed because for invalid handles, a stack of handles is maintained, to know the state of the last used handle.
public BoxInterface unwrapBox()
BoxInterface
instance. If the
handle is not a widget handle or is invalid, an
dynamic proxy
is returned.
Each unwrap call must be followed by an actual attribute/method invocation. This is needed because for invalid handles, a stack of handles is maintained, to know the state of the last used handle.
public BlankInterface unwrapBlank()
BlankInterface
instance. If the
handle is not a widget handle or is invalid, an
dynamic proxy
is returned.
Each unwrap call must be followed by an actual attribute/method invocation. This is needed because for invalid handles, a stack of handles is maintained, to know the state of the last used handle.
public DeblankInterface unwrapDeblank()
DeblankInterface
instance. If the
handle is not a widget handle or is invalid, an
dynamic proxy
is returned.
Each unwrap call must be followed by an actual attribute/method invocation. This is needed because for invalid handles, a stack of handles is maintained, to know the state of the last used handle.
public DirectManipulation unwrapDirectManipulation()
DirectManipulation
instance. If the
handle is not a widget handle or is invalid, an
dynamic proxy
is returned.
Each unwrap call must be followed by an actual attribute/method invocation. This is needed because for invalid handles, a stack of handles is maintained, to know the state of the last used handle.
public Droppable unwrapDroppable()
Droppable
instance. If the
handle is not a widget handle or is invalid, an
dynamic proxy
is returned.
Each unwrap call must be followed by an actual attribute/method invocation. This is needed because for invalid handles, a stack of handles is maintained, to know the state of the last used handle.
public CommonListWidget unwrapCommonListWidget()
CommonWidget
instance. If the
handle is not a widget handle or is invalid, an
dynamic proxy
is returned.
Each unwrap call must be followed by an actual attribute/method invocation. This is needed because for invalid handles, a stack of handles is maintained, to know the state of the last used handle.
public RadioSetInterface unwrapRadioSet()
RadioSetInterface
instance. If the
handle is not a widget handle or is invalid, an
dynamic proxy
is returned.
Each unwrap call must be followed by an actual attribute/method invocation. This is needed because for invalid handles, a stack of handles is maintained, to know the state of the last used handle.
public RectangleInterface unwrapRectangle()
RectangleInterface
instance. If the
handle is not a widget handle or is invalid, an
dynamic proxy
is returned.public CommonWindow unwrapWindow()
CommonWindow
instance. If the
handle is a window handle or is invalid, an
dynamic proxy
is returned.
Each unwrap call must be followed by an actual attribute/method invocation. This is needed because for invalid handles, a stack of handles is maintained, to know the state of the last used handle.
public XYCoordinates unwrapXY()
XYCoordinates
instance. If the
handle is a window handle or is invalid, an
dynamic proxy
is returned.
Each unwrap call must be followed by an actual attribute/method invocation. This is needed because for invalid handles, a stack of handles is maintained, to know the state of the last used handle.
public XmlData unwrapXmlData()
XmlData
instance.
If the handle is invalid, an dynamic proxy
is returned.
Each unwrap call must be followed by an actual attribute/method invocation. This is needed because for invalid handles, a stack of handles is maintained, to know the state of the last used handle.
public BaseDataType instantiateUnknown()
unknown value
.instantiateUnknown
in class BaseDataType
unknown value
.public BaseDataType duplicate()
clone()
method but returns an
instance of BaseDataType
and doesn't throw the
CloneNotSupportedException
.duplicate
in class BaseDataType
public int hashCode()
BaseDataType.equals(java.lang.Object)
.hashCode
in class BaseDataType
public java.lang.Object get()
Object
.
If this instance represents the unknown value
, a
null
will be returned.
Object
or null
if
this is unknown
.public void set(WrappedResource value)
WrappedResource
.value
- The value to be represented in this instance.public logical isValid()
true
if this instance can be used.public logical isValidEvent(character event)
event
- Name of the event.true
if this handle references a widget and the specified event is
valid for this type of widgets.public logical isValidEvent(java.lang.String event)
event
- Name of the event.true
if this handle references a widget and the specified event is
valid for this type of widgets.public boolean _isValid()
true
if this instance can be used.public boolean _isValidEvent(java.lang.String event)
event
- Name of the event.true
if this handle references a widget and the specified event is
valid for this type of widgets.public boolean _isValidEvent(character event)
event
- Name of the event.true
if this handle references a widget and the specified event is
valid for this type of widgets.public boolean isUnknown()
unknown value
.isUnknown
in class BaseDataType
true
if this instance is set to the
unknown value
.public void setUnknown()
unknown value
flag to
true
.
Warning: a separate call is needed to ensure that the data of this instance is set to the correct value.
setUnknown
in class BaseDataType
public void assign(BaseDataType value, boolean force)
If the value is not of type handle
, the following automatic type
conversion will occur:
unknown - The instance will be set to unknown value. handle - The wrapped value will be assigned as expected.
All other cases will generate an error.
This variant is meant to handle the cases of built-in functions and methods in the 4GL which have polymorphic return types (e.g. DYNAMIC-FUNCTION()). This should NOT be used for non-polymorphic assignments.
assign
in class BaseDataType
value
- The instance from which to copy state.force
- Flag to indicate if a pending error should be ignored (see
ErrorManager.isPendingError()
and the assignment forced regardless. Note
that normal assignment silently exits with no change if there is a pending error.
If this flag is true
, that check is bypassed and the assignment will
always be done.public void assign(handle value, boolean force)
value
- The instance from which to copy state.force
- Flag to indicate if a pending error should be ignored (see
ErrorManager.isPendingError()
and the assignment
forced regardless. Note that normal assignment silently
exits with no change if there is a pending error. If this
flag is true
, that check is bypassed and the
assignment will always be done.public void assign(WrappedResource value, boolean force)
value
- The instance from which to copy state.force
- Flag to indicate if a pending error should be ignored (see
ErrorManager.isPendingError()
and the assignment
forced regardless. Note that normal assignment silently
exits with no change if there is a pending error. If this
flag is true
, that check is bypassed and the
assignment will always be done.public void assign(java.lang.Object value)
This is a "no operation" in the case where silent error mode is active
AND an error has occurred in the current processing since the opening
call to ErrorManager.silentErrorEnable()
. This protection is
needed to ensure that the state of this instance does not change in
this case. This will not affect undo because that only occurs when
silent error mode is disabled.
value
- The instance from which to copy state. This must be of
type handle
or WrappedResource
.public void assign(handle value)
This is a "no operation" in the case where silent error mode is active
AND an error has occurred in the current processing since the opening
call to ErrorManager.silentErrorEnable()
. This protection is
needed to ensure that the state of this instance does not change in
this case. This will not affect undo because that only occurs when
silent error mode is disabled.
value
- The instance from which to copy state.public void assign(Undoable value)
value
- The instance from which to copy state.public void assign(WrappedResource value)
null
may be passed in which case
this instance will be set to the unknown value
.
This is a "no operation" in the case where silent error mode is active
AND an error has occurred in the current processing since the opening
call to ErrorManager.silentErrorEnable()
. This protection is
needed to ensure that the state of this instance does not change in
this case. This will not affect undo because that only occurs when
silent error mode is disabled.
value
- The instance from which to copy state.public int compareTo(java.lang.Object obj)
Comparable
interface.
The algorithm will fail to give meaningful results in the case where one tries to sort against other objects that do not represent compatible values.
obj
- The instance to compare against.unknown
.public java.lang.String toString()
ResourceIdHelper.DEFAULT_FORMAT
. If the instance represents the
unknown value
, a '?' will be returned.toString
in class java.lang.Object
public java.lang.String toString(java.lang.String fmt)
ResourceIdHelper.DEFAULT_FORMAT
.
If the instance represents the unknown value
, a '?' will be
returned.toString
in class BaseDataType
fmt
- The Progress 4GL format string or null
if the
default format is to be used.public java.lang.String toStringMessage()
MESSAGE
language statement. If the
instance represents the unknown value
, a '?' will be
returned.toStringMessage
in class BaseDataType
public java.lang.String toStringExport()
unknown value
, a
'?' will be returned.toStringExport
in class BaseDataType
public java.lang.String defaultFormatString()
Warning: this is larger than the Progress version because the range of handle values can be a 64-bit integer in this implementation.
defaultFormatString
in class BaseDataType
public void readExternal(java.io.ObjectInput in) throws java.io.IOException, java.lang.ClassNotFoundException
in
- The input source from which fields will be restored.java.io.IOException
- In case of I/O errors.java.lang.ClassNotFoundException
- If payload can't be instantiated.public void writeExternal(java.io.ObjectOutput out) throws java.io.IOException
out
- The output destination to which fields will be saved.java.io.IOException
- In case of I/O errors.public WrappedResource getResource()
resource
.public java.lang.Long getResourceId()