xArch/xADL 2.0 Data Binding Library

edu.uci.isr.xarch.hints
Interface IRenderingHints

All Superinterfaces:
IXArchElement
All Known Implementing Classes:
RenderingHintsImpl

public interface IRenderingHints
extends IXArchElement

Interface for accessing objects of the RenderingHints xsi:type in the hints namespace.

Author:
Automatically generated by xArch apigen

Field Summary
static XArchTypeMetadata TYPE_METADATA
           
 
Fields inherited from interface edu.uci.isr.xarch.IXArchElement
DEPTH_INFINITY, DEPTH_ONE, DEPTH_ZERO
 
Method Summary
 void addHints(IHints newHints)
          Add a hints to this RenderingHints.
 void addHintss(Collection hintss)
          Add a collection of hintss to this RenderingHints.
 void clearHintss()
          Remove all hintss from this RenderingHints.
 Collection getAllHintss()
          Get all the hintss from this RenderingHints.
 boolean hasAllHintss(Collection hintssToCheck)
          Determine if this RenderingHints contains each element in the given set of hintss.
 boolean hasHints(IHints hintsToCheck)
          Determine if this RenderingHints contains a given hints.
 Collection hasHintss(Collection hintssToCheck)
          Determine if this RenderingHints contains the given set of hintss.
 boolean isEquivalent(IRenderingHints RenderingHintsToCheck)
          Determine if another RenderingHints is equivalent to this one, ignoring ID's.
 void removeHints(IHints hintsToRemove)
          Remove the given hints from this RenderingHints.
 void removeHintss(Collection hintss)
          Remove all the given hintss from this RenderingHints.
 
Methods inherited from interface edu.uci.isr.xarch.IXArchElement
cloneElement, getInstanceMetadata, getTypeMetadata, getXArch, setXArch
 

Field Detail

TYPE_METADATA

public static final XArchTypeMetadata TYPE_METADATA
Method Detail

addHints

public void addHints(IHints newHints)
Add a hints to this RenderingHints.

Parameters:
newHints - hints to add.

addHintss

public void addHintss(Collection hintss)
Add a collection of hintss to this RenderingHints.

Parameters:
hintss - hintss to add.

clearHintss

public void clearHintss()
Remove all hintss from this RenderingHints.


removeHints

public void removeHints(IHints hintsToRemove)
Remove the given hints from this RenderingHints. Matching is done by the isEquivalent(...) function.

Parameters:
hintsToRemove - hints to remove.

removeHintss

public void removeHintss(Collection hintss)
Remove all the given hintss from this RenderingHints. Matching is done by the isEquivalent(...) function.

Parameters:
hintss - hints to remove.

getAllHintss

public Collection getAllHintss()
Get all the hintss from this RenderingHints.

Returns:
all hintss in this RenderingHints.

hasHints

public boolean hasHints(IHints hintsToCheck)
Determine if this RenderingHints contains a given hints.

Returns:
true if this RenderingHints contains the given hintsToCheck, false otherwise.

hasHintss

public Collection hasHintss(Collection hintssToCheck)
Determine if this RenderingHints contains the given set of hintss.

Parameters:
hintssToCheck - hintss to check for.
Returns:
Collection of java.lang.Boolean. If the ith element in hintss was found, then the ith element of the collection will be set to true, otherwise it will be set to false. Matching is done with the isEquivalent(...) method.

hasAllHintss

public boolean hasAllHintss(Collection hintssToCheck)
Determine if this RenderingHints contains each element in the given set of hintss.

Parameters:
hintssToCheck - hintss to check for.
Returns:
true if every element in hintss is found in this RenderingHints, false otherwise.

isEquivalent

public boolean isEquivalent(IRenderingHints RenderingHintsToCheck)
Determine if another RenderingHints is equivalent to this one, ignoring ID's.

Parameters:
RenderingHintsToCheck - RenderingHints to compare to this one.
Returns:
true if all the child elements of this RenderingHints are equivalent, false otherwise.

xArch/xADL 2.0 Data Binding Library