public interface

RWIterateSettings

com.microstrategy.web.objects.RWIterateSettings

Summary

Fields
public static final int[] VISIBLE_ONLY_ALL
public static final int[] VISIBLE_ONLY_HEADER_FOOTER_DETAIL
public static final int[] VISIBLE_ONLY_NONE
Public Methods
abstract String getLayoutKey()
abstract boolean isDesignMode()
abstract void setDesignMode(boolean isDesignMode)
abstract void setLayoutKey(String key)
abstract void setSuppressEmptySections(boolean suppress)
abstract void setVisitVisibleOnly(int[] visibleOnly)
Array of EnumRWUnitTypes determines the unit types that will be iterated only if they are visible.
abstract boolean suppressEmptySections()
Whether to omit sections that have no subsections.
abstract int[] visitVisibleOnly()
abstract boolean visitVisibleOnly(RWUnit unit)
Check whether a unit type is in a given array of acceptable matches.

Fields

public static final int[] VISIBLE_ONLY_ALL

public static final int[] VISIBLE_ONLY_HEADER_FOOTER_DETAIL

public static final int[] VISIBLE_ONLY_NONE

Public Methods

public abstract String getLayoutKey ()

public abstract boolean isDesignMode ()

public abstract void setDesignMode (boolean isDesignMode)

public abstract void setLayoutKey (String key)

public abstract void setSuppressEmptySections (boolean suppress)

Parameters
suppress whether to omit sections that have no subsections.

public abstract void setVisitVisibleOnly (int[] visibleOnly)

Array of EnumRWUnitTypes determines the unit types that will be iterated only if they are visible.

Parameters
visibleOnly EnumRWUnitTypes of units that will be iterated only if they are visible.

public abstract boolean suppressEmptySections ()

Whether to omit sections that have no subsections. This works in conjunction with setVisitVisibleOnly(int[]) when non-visible subsections are suppressed. By default, this is true.

Returns
  • whether to omit sections that have no (visible) subsections.

public abstract int[] visitVisibleOnly ()

Returns

public abstract boolean visitVisibleOnly (RWUnit unit)

Check whether a unit type is in a given array of acceptable matches. If unit is null or visible only array is VISIBLE_ONLY_NONE, false is returned. If the visible only array is length 0, true is returned.

Parameters
unit unit to test
Returns
  • whether the given unit type is in the visible only array.
Throws
WebObjectsException
See Also